Skip to main content

ISummarizeResult Interface

Represents a summary at a current sequence number.

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 ISummarizeResult

Properties

Property Alerts Type Description
stats Alpha ISummaryStats
summary Alpha SummaryTree

Property Details

stats

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

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: SummaryTree;

Type: SummaryTree