Skip to main content

TreeNodeSchemaClassUnsafe Interface

Unenforced version of TreeNodeSchemaClass.

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​

interface TreeNodeSchemaClassUnsafe<out Name extends string, out Kind extends NodeKind, out TNode extends Unenforced<TreeNode>, in TInsertable, out ImplicitlyConstructable extends boolean, out Info, out TCustomMetadata = unknown> extends TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info, never, TCustomMetadata>

Extends: TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info, never, TCustomMetadata>

Type Parameters​

Parameter Constraint Default Description
Name string
Kind NodeKind
TNode Unenforced<TreeNode>
TInsertable
ImplicitlyConstructable boolean
Info
TCustomMetadata unknown

Remarks​

Do not use this type directly: it is only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.

Construct Signatures​

ConstructSignature Modifiers Return Type Description
new (data: TInsertable | InternalTreeNode): Unhydrated<TNode> sealed Unhydrated<TNode> Constructs an Unhydrated node with this schema.

Construct Signature Details​

new (data: TInsertable | InternalTreeNode): Unhydrated<TNode>​

Constructs an Unhydrated node with 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.

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 */
new (data: TInsertable | InternalTreeNode): Unhydrated<TNode>;
Remarks​

This constructor is also used internally to construct hydrated nodes with a different parameter type. Therefore, overriding this constructor with different argument types is not type-safe and is not supported.

Parameters​

Parameter Type Description
data TInsertable | InternalTreeNode

Returns​

Return type: Unhydrated<TNode>