Skip to main content

TreeNodeSchemaNonClass TypeAlias

Schema which is not a class.

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 type TreeNodeSchemaNonClass<Name extends string = string, Kind extends NodeKind = NodeKind, TNode extends TreeNode | TreeLeafValue = TreeNode | TreeLeafValue, TInsertable = never, ImplicitlyConstructable extends boolean = boolean, Info = unknown, TConstructorExtra = never, TCustomMetadata = unknown> = TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info, TInsertable, TCustomMetadata> & (undefined extends TConstructorExtra ? {
    create(data?: TInsertable | TConstructorExtra): TNode;
} : {
    create(data: TInsertable | TConstructorExtra): TNode;
});

Type Parameters​

Parameter Constraint Default Description
Name string string
Kind NodeKind NodeKind
TNode TreeNode | TreeLeafValue TreeNode | TreeLeafValue
TInsertable never
ImplicitlyConstructable boolean boolean
Info unknown
TConstructorExtra never
TCustomMetadata unknown

Remarks​

This is used for schema which cannot have their instances constructed using constructors, like leaf schema.