ISummaryTree Interface
Packages > @fluidframework/driver-definitions > ISummaryTree
Tree Node data structure with children that are nodes of SummaryObject type: Blob, Handle, Attachment or another Tree.
Signature
export interface ISummaryTree
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| groupId | optional |
string | Represents the loading group to which the summary 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. |
| tree | { [path: string]: SummaryObject; } | ||
| type | SummaryType.Tree | ||
| unreferenced | optional |
true | Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced. |
Property Details
groupId
Represents the loading group to which the summary 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.
Signature
groupId?: string;
Type: string
tree
Signature
tree: {
[path: string]: SummaryObject;
};
Type: { [path: string]: SummaryObject ; }
type
Signature
type: SummaryType.Tree;
Type: SummaryType.Tree
unreferenced
Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
Signature
unreferenced?: true;
Type: true