ITreeAlpha Interface
ITree extended with some alpha APIs.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 TreeAlpha.(exportVerbose:1) using stored keys. |
Method Details
exportSimpleSchema
Exports the SimpleTreeSchema that is stored in the tree, using stored keys for object fields.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
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 TreeAlpha.(exportVerbose:1) using stored keys.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
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