SummaryTreeBuilder Class

A helper class for building summary trees.

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

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

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

Signature

export declare class SummaryTreeBuilder implements ISummaryTreeWithStats

Implements: ISummaryTreeWithStats

Remarks

Uses the builder pattern.

Constructors

Constructor	Alerts	Description
(constructor)(params)	Alpha	Constructs a new instance of the SummaryTreeBuilder class

Properties

Property	Alerts	Modifiers	Type	Description
stats	Alpha	readonly	Readonly<ISummaryStats>
summary	Alpha	readonly	ISummaryTree

Constructor Details

(constructor)

Constructs a new instance of the SummaryTreeBuilder class

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

constructor(params?: {
        groupId?: string;
    });

Parameters

Parameter	Modifiers	Type	Description
params	optional	{ groupId?: string; }

Property Details

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

get stats(): Readonly<ISummaryStats>;

Type: Readonly<ISummaryStats>

summary

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

get summary(): ISummaryTree;

Type: ISummaryTree