Skip to main content

FieldKind Enum

Kind of a field on an TreeObjectNode.

Signature​

export declare enum FieldKind

Remarks​

More kinds may be added over time, so do not assume this is an exhaustive set. See FieldSchema for where these are used, and SchemaFactory for how to create schema which use them.

Flags​

FlagDescription
IdentifierA special readonly field used for node identifier strings.
OptionalA field which can be empty or filled.
RequiredA field which must always be filled.

Identifier​

A special readonly field used for node identifier strings.

Signature​

Identifier = 2

Remarks​

Only allows exactly one child.

See identifier for more details.

Optional​

A field which can be empty or filled.

Signature​

Optional = 0

Remarks​

Allows 0 or one child.

Required​

A field which must always be filled.

Signature​

Required = 1

Remarks​

Only allows exactly one child.