ConciseTree TypeAlias

Concise encoding of a TreeNode or TreeLeafValue.

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 ConciseTree<THandle = IFluidHandle> = Exclude<TreeLeafValue, IFluidHandle> | THandle | ConciseTree<THandle>[] | {
    [key: string]: ConciseTree<THandle>;
};

Type Parameters

Parameter	Default	Description
THandle	IFluidHandle

Remarks

This is "concise" meaning that explicit type information is omitted. If the schema is compatible with preventAmbiguity, types will be lossless and compatible with TreeAlpha.create (unless the options are used to customize it).

Every TreeNode is an array or object. Any IFluidHandle values have been replaced by THandle.