LeafSchema Interface

A TreeNodeSchema for a TreeLeafValue.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

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

Signature

/** @sealed */
export interface LeafSchema<Name extends string, T extends TreeLeafValue> extends TreeNodeSchemaNonClass<`com.fluidframework.leaf.${Name}`, NodeKind.Leaf, T, T, true>

Extends: TreeNodeSchemaNonClass<`com.fluidframework.leaf.${Name}`, NodeKind.Leaf, T, T, true>

Type Parameters

Parameter	Constraint	Description
Name	string
T	TreeLeafValue

Remarks

This is just a more specific alias for a particular TreeNodeSchemaNonClass. It only exists to make the API (particularly errors, IntelliSense, and generated .d.ts files) more readable.

See SchemaFactory and its various properties for actual leaf schema objects.