TreeSchema Interface
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 TreeSchema extends SimpleTreeSchema
Extends: SimpleTreeSchema
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| definitions | Alpha |
readonly |
ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema> | The complete set of node schema definitions recursively referenced by the tree's root. |
| root | Alpha |
readonly |
FieldSchemaAlpha | 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.
Signature
readonly definitions: ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>;
Type: ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>
Remarks
The keys are the schemas' identifiers.
Information about if a schema is staged or not is not available as the "Simple Schema" layer of abstraction: they are included unconditionally. Options for filtering out staged schemas from view schema are available in extractPersistedSchema(schema, oldestCompatibleClient, includeStaged).
root
The tree field representing the root of the tree.
For more information about our API support guarantees, see here.
Signature
readonly root: FieldSchemaAlpha;
Type: FieldSchemaAlpha