FieldSchemaAlpha Class

FieldSchema including alpha APIs (currently SimpleFieldSchema).

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

To use, import via fluid-framework/alpha.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export declare class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends ImplicitAllowedTypes = ImplicitAllowedTypes, TCustomMetadata = unknown> extends FieldSchema<Kind, Types, TCustomMetadata> implements SimpleFieldSchema

Extends: FieldSchema<Kind, Types, TCustomMetadata>

Implements: SimpleFieldSchema

Type Parameters

Parameter	Constraint	Default	Description
Kind	FieldKind	FieldKind
Types	ImplicitAllowedTypes	ImplicitAllowedTypes
TCustomMetadata		unknown

Remarks

This class will go away once the alpha APIs are stable and implemented by FieldSchema.

Constructors

Constructor	Alerts	Description
(constructor)(kind, types, annotatedAllowedTypes, props)	Alpha	Constructs a new instance of the FieldSchemaAlpha class

Properties

Property	Alerts	Modifiers	Type	Description
allowedTypesIdentifiers	Alpha	readonly	ReadonlySet<string>
allowedTypesMetadata	Alpha	readonly	AllowedTypesMetadata	Metadata on the types of tree nodes allowed on this field.
annotatedAllowedTypes	Alpha	readonly	ImplicitAnnotatedAllowedTypes
annotatedAllowedTypeSet	Alpha	readonly	ReadonlyMap<TreeNodeSchema, AllowedTypeMetadata>	What types of tree nodes are allowed in this field and their annotations.

Constructor Details

(constructor)

Constructs a new instance of the FieldSchemaAlpha class

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

protected constructor(kind: Kind, types: Types, annotatedAllowedTypes: ImplicitAnnotatedAllowedTypes, props?: FieldProps<TCustomMetadata>);

Parameters

Parameter	Modifiers	Type	Description
kind		Kind
types		Types
annotatedAllowedTypes		ImplicitAnnotatedAllowedTypes
props	optional	FieldProps<TCustomMetadata>

Property Details

allowedTypesIdentifiers

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

get allowedTypesIdentifiers(): ReadonlySet<string>;

Type: ReadonlySet<string>

allowedTypesMetadata

Metadata on the types of tree nodes allowed on this field.

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly allowedTypesMetadata: AllowedTypesMetadata;

Type: AllowedTypesMetadata

annotatedAllowedTypes

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly annotatedAllowedTypes: ImplicitAnnotatedAllowedTypes;

Type: ImplicitAnnotatedAllowedTypes

annotatedAllowedTypeSet

What types of tree nodes are allowed in this field and their annotations.

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

get annotatedAllowedTypeSet(): ReadonlyMap<TreeNodeSchema, AllowedTypeMetadata>;

Type: ReadonlyMap<TreeNodeSchema, AllowedTypeMetadata>

Remarks

Counterpart to annotatedAllowedTypes, with any lazy definitions evaluated.