NodeSchemaMetadata Interface
Metadata associated with a 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
/** @sealed */
export interface NodeSchemaMetadata<out TCustomMetadata = unknown>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TCustomMetadata | unknown |
Remarks
Specified via metadata.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| custom | optional, readonly |
TCustomMetadata | undefined | User-defined metadata. |
| description | optional, readonly |
string | undefined | The description of the Node Schema. |
Property Details
custom
User-defined metadata.
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 custom?: TCustomMetadata | undefined;
Type: TCustomMetadata | undefined
description
The description of 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 description?: string | undefined;
Type: string | undefined
Remarks
If provided, will be used by the system in scenarios where a description of the kind of node is useful. E.g., when converting a Node Schema to JSON Schema, this description will be used as the description property.