SimpleNodeSchema TypeAlias

A simple, shallow representation of a schema for a node.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/tree/alpha.

For more information about our API support guarantees, see here.

Signature

export type SimpleNodeSchema = SimpleLeafNodeSchema | SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleObjectNodeSchema;

Remarks

This definition is incomplete, and references child types by identifiers. To be useful, this generally needs to be used as a part of a complete SimpleTreeSchema, which contains backing definitions for each referenced identifier.

Note that, as documented on NodeKind, more kinds of nodes may be added, and therefore code should not assume that switching over all these cases can be done exhaustively.