IGenerateSummaryTreeResult Interface

Results of submitSummary after generating the summary tree.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

For more information about our API support guarantees, see here .

Signature

export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage">

Extends: Omit<IBaseSummarizeResult , “stage”>

Property	Alerts	Modifiers	Type	Description
generateDuration	`Alpha`	`readonly`	number	Time it took to generate the summary tree and stats.
stage	`Alpha`	`readonly`	"generate"
summaryStats	`Alpha`	`readonly`	IGeneratedSummaryStats	Stats for generated summary tree.
summaryTree	`Alpha`	`readonly`	ISummaryTree	Generated summary tree.

Time it took to generate the summary tree and stats.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here .

readonly generateDuration: number;

Type: number

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here .

readonly stage: "generate";

Type: “generate”

Stats for generated summary tree.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here .

readonly summaryStats: IGeneratedSummaryStats;

Type: IGeneratedSummaryStats

Generated summary tree.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here .

readonly summaryTree: ISummaryTree;

Type: ISummaryTree