TreeNodeSchemaCore Interface

Data common to all tree node schema.

Signature

export interface TreeNodeSchemaCore<out Name extends string, out Kind extends NodeKind, out ImplicitlyConstructable extends boolean, out Info = unknown>

Type Parameters

Parameter	Constraint	Default
Name	string
Kind	NodeKind
ImplicitlyConstructable	boolean
Info		unknown

Properties

Property	Modifiers	Type	Description
identifier	`readonly`	Name
implicitlyConstructable	`readonly`	ImplicitlyConstructable	When constructing insertable content, data that could be passed to the node's constructor can be used instead of an Unhydrated node iff implicitlyConstructable is true.
info	`readonly`	Info	Data used to define this schema.
kind	`readonly`	Kind

Property Details

identifier

Signature

readonly identifier: Name;

implicitlyConstructable

When constructing insertable content, data that could be passed to the node’s constructor can be used instead of an Unhydrated node iff implicitlyConstructable is true.

Signature

readonly implicitlyConstructable: ImplicitlyConstructable;

info

Data used to define this schema.

Signature

readonly info: Info;

Remarks

The format depends on the kind of node it is for. For example, the “object” node kind could store the field schema here.

kind

Signature

readonly kind: Kind;