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">

Properties

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.

Property Details

generateDuration

Time it took to generate the summary tree and stats.

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

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

Signature

readonly generateDuration: number;

Type: number

stage

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

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

Signature

readonly stage: "generate";

Type: "generate"

summaryStats

Stats for generated summary tree.

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

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

Signature

readonly summaryStats: IGeneratedSummaryStats;

Type: IGeneratedSummaryStats

summaryTree

Generated summary tree.

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

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

Signature

readonly summaryTree: ISummaryTree;

Type: ISummaryTree