Skip to main content
Version: v2

ISummaryTree Interface

Tree Node data structure with children that are nodes of SummaryObject type: Blob, Handle, Attachment or another Tree.

Signature​

export interface ISummaryTree

Properties​

PropertyModifiersTypeDescription
groupIdoptionalstringRepresents 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; }The object containing all the tree's SummaryObject children.
typeSummaryType.Tree
unreferencedoptionaltrueIndicates 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​

The object containing all the tree's SummaryObject children.

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