SimpleTreeSchema Interface
A simplified representation of a schema for a tree.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 SimpleTreeSchema
Remarks
Contains the complete set of schema definitions required to resolve references, which are represented inline with identifiers.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| definitions | Alpha |
readonly |
ReadonlyMap<string, SimpleNodeSchema> | The complete set of node schema definitions recursively referenced by the tree's root. |
| root | Alpha |
readonly |
SimpleFieldSchema | The tree field representing the root of the tree. |
Property Details
definitions
The complete set of node schema definitions recursively referenced by the tree's root.
For more information about our API support guarantees, see here.
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
readonly definitions: ReadonlyMap<string, SimpleNodeSchema>;
Type: ReadonlyMap<string, SimpleNodeSchema>
Remarks
the keys are the schemas' identifiers.
root
The tree field representing the root of the tree.
For more information about our API support guarantees, see here.
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
readonly root: SimpleFieldSchema;
Type: SimpleFieldSchema