ISnapshotTree Interface

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 ISnapshotTree

Properties

Property	Alerts	Modifiers	Type	Description
blobs	Beta		{ [path: string]: string; }
groupId	Beta	optional	string	Represents the loading group to which the snapshot 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	Beta	optional	string
trees	Beta		{ [path: string]: ISnapshotTree; }
unreferenced	Beta	optional	true	Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.

Property Details

blobs

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

blobs: {
        [path: string]: string;
    };

Type: { [path: string]: string; }

groupId

Represents the loading group to which the snapshot 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 for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

groupId?: string;

Type: string

id

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

id?: string;

Type: string

trees

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

trees: {
        [path: string]: ISnapshotTree;
    };

Type: { [path: string]: ISnapshotTree; }

unreferenced

Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

unreferenced?: true;

Type: true