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 @fluidframework/tree/alpha.

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

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, allowedTypes, props)	Alpha	Constructs a new instance of the FieldSchemaAlpha class

Properties

Property	Alerts	Modifiers	Type	Description
allowedTypesIdentifiers	Alpha	readonly	ReadonlySet<string>

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.

Signature

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

Parameters

Parameter	Modifiers	Type	Description
kind		Kind
allowedTypes		Types
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.

Signature

get allowedTypesIdentifiers(): ReadonlySet<string>;

Type: ReadonlySet<string>