NodeSchemaOptions Interface
Additional information to provide to Node Schema creation.
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 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.
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 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.