ISummaryTreeWithStats Interface
Packages > @fluidframework/runtime-definitions > ISummaryTreeWithStats
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.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISummaryTreeWithStats
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| stats | Alpha |
ISummaryStats | Represents an aggregation of node counts and blob sizes associated to the current summary information |
| summary | Alpha |
ISummaryTree | A recursive data structure that will be converted to a snapshot tree and uploaded to the backend. |
Property Details
stats
Represents an aggregation of node counts and blob sizes associated to the current summary information
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
stats: ISummaryStats;
Type: ISummaryStats
summary
A recursive data structure that will be converted to a snapshot tree and uploaded to the backend.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
summary: ISummaryTree;
Type: ISummaryTree