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.
Sealed
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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.