SummaryTreeBuilder Class
Signature
export declare class SummaryTreeBuilder implements ISummaryTreeWithStats
Implements: ISummaryTreeWithStats
Constructors
| Constructor | Description |
|---|---|
| (constructor)() | Constructs a new instance of the SummaryTreeBuilder class |
Properties
| Property | Type | Description |
|---|---|---|
| stats | Readonly<ISummaryStats> | |
| summary | ISummaryTree |
Methods
| Method | Return Type | Description |
|---|---|---|
| addAttachment(id) | void | |
| addBlob(key, content) | void | |
| addHandle(key, handleType, handle) | void | |
| addWithStats(key, summarizeResult) | void | |
| getSummaryTree() | ISummaryTreeWithStats |
Constructor Details
(constructor)
Constructs a new instance of the SummaryTreeBuilder class
Signature
constructor();
Property Details
stats
Signature
get stats(): Readonly<ISummaryStats>;
Type: Readonly<ISummaryStats>
summary
Signature
get summary(): ISummaryTree;
Type: ISummaryTree
Method Details
addAttachment
Signature
addAttachment(id: string): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string |
addBlob
Signature
addBlob(key: string, content: string | Uint8Array): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | |
| content | string | Uint8Array |
addHandle
Signature
addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | |
| handleType | SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment | |
| handle | string |
addWithStats
Signature
addWithStats(key: string, summarizeResult: ISummarizeResult): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | |
| summarizeResult | ISummarizeResult |
getSummaryTree
Signature
getSummaryTree(): ISummaryTreeWithStats;
Returns
Return type: ISummaryTreeWithStats