SimpleNodeSchemaBase Interface
Base interface for TreeNodeSchema and SimpleNodeSchema types. Once simple schema is stable this doesn't have a reason to be kept @system, but it could be.
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here.
Sealed
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 SimpleNodeSchemaBase<out TNodeKind extends NodeKind, out TCustomMetadata = unknown>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TNodeKind | NodeKind | ||
| TCustomMetadata | unknown |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| kind | readonly |
TNodeKind | The NodeKind. |
| metadata | readonly |
NodeSchemaMetadata<TCustomMetadata> | User-provided NodeSchemaMetadata for this schema. |
Property Details
kind
The NodeKind.
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here.
Signature
readonly kind: TNodeKind;
Type: TNodeKind
Remarks
can be used to type-switch between implementations.
metadata
User-provided NodeSchemaMetadata for this schema.
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here.
Signature
readonly metadata: NodeSchemaMetadata<TCustomMetadata>;
Type: NodeSchemaMetadata<TCustomMetadata>