ISummaryHandle Interface

Packages > @fluidframework/protocol-definitions > ISummaryHandle

Path to a summary tree object from the last successful summary indicating the summary object hasn’t changed since it was uploaded.

Signature

export interface ISummaryHandle

Example

To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS. An example of handle would be: ‘//’.

Properties

Property Type Description
handle string Unique path that identifies the corresponding sub-tree in a previous summary.
handleType SummaryTypeNoHandle Type of Summary Handle (SummaryType.Handle is not supported).
type SummaryType.Handle

Property Details

handle

Unique path that identifies the corresponding sub-tree in a previous summary.

Signature

handle: string;

Type: string

handleType

Type of Summary Handle (SummaryType.Handle is not supported).

Signature

handleType: SummaryTypeNoHandle;

Type: SummaryTypeNoHandle

type

Signature

type: SummaryType.Handle;

Type: SummaryType.Handle