Skip to main content

ExposedProperties Interface

An interface for exposing properties of classes to an agent.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/type-factory/alpha.

For more information about our API support guarantees, see here.

Signature​

export interface ExposedProperties

Methods​

MethodAlertsReturn TypeDescription
exposeProperty(constructor, name, def)AlphavoidExpose a property with type factory type and metadata.
exposeProperty(constructor, name, tfType)AlphavoidExpose a property with type factory type (simple form).

Method Details​

exposeProperty​

Expose a property with type factory type and metadata.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

exposeProperty<S extends Ctor, K extends string>(constructor: S, name: K, def: {
schema: TypeFactoryType;
description?: string;
readOnly?: boolean;
}): void;
Type Parameters​
ParameterConstraintDescription
SCtor
Kstring

Parameters​

ParameterTypeDescription
constructorS
nameK
def{ schema: TypeFactoryType; description?: string; readOnly?: boolean; }

exposeProperty​

Expose a property with type factory type (simple form).

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

exposeProperty<S extends Ctor, K extends string>(constructor: S, name: K, tfType: TypeFactoryType): void;
Type Parameters​
ParameterConstraintDescription
SCtor
Kstring

Parameters​

ParameterTypeDescription
constructorS
nameK
tfTypeTypeFactoryType