Packages > @fluidframework/tree > FieldKind

FieldKind

Kind of a field on a node.

Signature

export declare enum FieldKind

Remarks

More kinds may be added over time, so do not assume this is an exhaustive set.

Flags

Flag Description
Identifier A special field used for node identifiers.
Optional A field which can be empty or filled.
Required A field which must always be filled.

Identifier

A special field used for node identifiers.

Signature

Identifier = 2

Remarks

Only allows exactly one child.

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.