NodeSchemaOptions Interface
Additional information to provide to Node Schema creation.
Input
This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.
Signature
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
This specifies metadata which has more details about its use.