Skip to main content

NodeSchemaOptionsAlpha Interface

Additional information to provide to Node Schema creation. Includes fields for alpha features.

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.

Signature

export interface NodeSchemaOptionsAlpha<out TCustomMetadata = unknown> extends NodeSchemaOptions<TCustomMetadata>

Extends: NodeSchemaOptions<TCustomMetadata>

Type Parameters

Parameter Default Description
TCustomMetadata unknown Custom metadata properties to associate with the Node Schema. See custom.

Properties

Property Alerts Modifiers Type Description
persistedMetadata Alpha optional, readonly JsonCompatibleReadOnlyObject | undefined The persisted metadata for this schema element.

Property Details

persistedMetadata

The persisted metadata for this schema element.

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

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

Signature
readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;

Type: JsonCompatibleReadOnlyObject | undefined