Skip to main content
Version: v1

IGenerateSummaryTreeResult Interface

Results of submitSummary after generating the summary tree.

Signature

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

Extends: Omit<IBaseSummarizeResult

Properties

Property Type Description
forcedFullTree boolean True if the full tree regeneration with no handle reuse optimizations was forced.
generateDuration number Time it took to generate the summary tree and stats.
stage "generate"
summaryStats IGeneratedSummaryStats Stats for generated summary tree.
summaryTree ISummaryTree Generated summary tree.

Property Details

forcedFullTree

True if the full tree regeneration with no handle reuse optimizations was forced.

Signature

readonly forcedFullTree: boolean;

Type: boolean

generateDuration

Time it took to generate the summary tree and stats.

Signature

readonly generateDuration: number;

Type: number

stage

Signature

readonly stage: "generate";

Type: "generate"

summaryStats

Stats for generated summary tree.

Signature

readonly summaryStats: IGeneratedSummaryStats;

Type: IGeneratedSummaryStats

summaryTree

Generated summary tree.

Signature

readonly summaryTree: ISummaryTree;

Type: ISummaryTree