ITree Interface
Packages > @fluidframework/driver-definitions > ITree
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ITree
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| entries | Alpha |
ITreeEntry[] | ||
| groupId | Alpha |
optional |
string | Represents the loading group to which the tree belongs to. Please refer to this readme for more context. README Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is intentional to minimize snapshot/summary size. |
| id | Alpha |
optional |
string | Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case it is known that the ITree has already been created and stored |
| unreferenced | Alpha |
optional |
true | Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced. |
Property Details
entries
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
entries: ITreeEntry[];
Type: ITreeEntry []
groupId
Represents the loading group to which the tree belongs to. Please refer to this readme for more context. README Also note that “groupId” is the same as “loadingGroupId” used elsewhere in the repo. The naming discrepancy is intentional to minimize snapshot/summary size.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
groupId?: string;
Type: string
id
Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case it is known that the ITree has already been created and stored
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
id?: string;
Type: string
unreferenced
Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
unreferenced?: true;
Type: true