ITreeAlpha Interface
ITree extended with some alpha APIs.
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 ITreeAlpha extends ITree
Extends: ITree
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| exportSimpleSchema() | Alpha |
SimpleTreeSchema | Exports the SimpleTreeSchema that is stored in the tree, using stored keys for object fields. |
| exportVerbose() | Alpha |
VerboseTree | undefined | Exports root in the same format as exportVerbose(node, options) using stored keys. |
Method Details
exportSimpleSchema
Exports the SimpleTreeSchema that is stored in the tree, using stored keys for object fields.
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
exportSimpleSchema(): SimpleTreeSchema;
Remarks
To get the schema using property keys, use getSimpleSchema(schema) on the view schema.
Returns
Return type: SimpleTreeSchema
exportVerbose
Exports root in the same format as exportVerbose(node, options) using stored keys.
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
exportVerbose(): VerboseTree | undefined;
Remarks
This is undefined if and only if the root field is empty (this can only happen if the root field is optional).
Returns
Return type: VerboseTree | undefined