Skip to main content

NodeSchemaOptions Interface

Additional information to provide to Node Schema creation.

Signature​

/** @sealed */
export interface NodeSchemaOptions<out TCustomMetadata = unknown>

Type Parameters​

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

Properties​

Property Modifiers Type Description
metadata optional, readonly NodeSchemaMetadata<TCustomMetadata> | undefined Optional metadata to associate with the Node Schema.

Property Details​

metadata​

Optional metadata to associate with the Node Schema.

Signature​

readonly metadata?: NodeSchemaMetadata<TCustomMetadata> | undefined;

Type: NodeSchemaMetadata<TCustomMetadata> | undefined

Remarks​

Note: this metadata is not persisted nor made part of the collaborative state; it is strictly client-local. Different clients in the same collaborative session may see different metadata for the same field.