Skip to main content
Version: v1

ISummaryTreeWithStats Interface

Represents the summary tree for a node along with the statistics for that tree. For example, for a given data store, it contains the data for data store along with a subtree for each of its DDS. Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject will be taking part of the summarization process.

Signature​

export interface ISummaryTreeWithStats

Properties​

PropertyTypeDescription
statsISummaryStatsRepresents an agreggation of node counts and blob sizes associated to the current summary information
summaryISummaryTreeA recursive data structure that will be converted to a snapshot tree and uploaded to the backend.

Property Details​

stats​

Represents an agreggation of node counts and blob sizes associated to the current summary information

Signature​

stats: ISummaryStats;

Type: ISummaryStats

summary​

A recursive data structure that will be converted to a snapshot tree and uploaded to the backend.

Signature​

summary: ISummaryTree;

Type: ISummaryTree