SummaryType Namespace

Packages > @fluidframework/protocol-definitions > SummaryType

Type tag used to distinguish different types of nodes in a ISummaryTree .

Signature

export declare namespace SummaryType

Variables

Variable Modifiers Type Description
Attachment readonly Attachment Unique identifier to larger blobs uploaded outside of the summary. Ex. DDS has large images or video that will be uploaded by the BlobManager and receive an Id that can be used in the summary.
Blob readonly Blob Represents a blob of data that is added to the summary. Such as the user data that is added to the DDS or metadata added by runtime such as data store / channel attributes.
Handle readonly Handle Path to a summary tree object from the last successful summary.
Tree readonly Tree Represents a sub-tree in the summary.

Variable Details

Attachment

Unique identifier to larger blobs uploaded outside of the summary. Ex. DDS has large images or video that will be uploaded by the BlobManager and receive an Id that can be used in the summary.

Signature

Attachment: Attachment

Type: Attachment

Blob

Represents a blob of data that is added to the summary. Such as the user data that is added to the DDS or metadata added by runtime such as data store / channel attributes.

Signature

Blob: Blob

Type: Blob

Handle

Path to a summary tree object from the last successful summary.

Signature

Handle: Handle

Type: Handle

Tree

Represents a sub-tree in the summary.

Signature

Tree: Tree

Type: Tree