SummaryTreeAssembler Class
Summary tree assembler (without stats collection).
Signature
export declare class SummaryTreeAssembler
Constructors
| Constructor | Description |
|---|---|
| (constructor)(props) | Constructs a new instance of the SummaryTreeAssembler class |
Properties
| Property | Type | Description |
|---|---|---|
| summary | ISummaryTree | Get final summary |
Methods
| Method | Return Type | Description |
|---|---|---|
| addAttachment(id) | void | Add attachment to summary |
| addBlob(key, content) | void | Add blob to summary |
| addHandle(key, handleType, handle) | void | Add handle to summary |
| addTree(key, summary) | void | Add tree to summary |
Constructor Details
(constructor)
Constructs a new instance of the SummaryTreeAssembler class
Signature
constructor(props?: ISummaryTreeAssemblerProps | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| props | optional | ISummaryTreeAssemblerProps | undefined |
Property Details
summary
Get final summary
Signature
get summary(): ISummaryTree;
Type: ISummaryTree
Method Details
addAttachment
Add attachment to summary
Signature
addAttachment(id: string): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string |
addBlob
Add blob to summary
Signature
addBlob(key: string, content: string | Uint8Array): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | |
| content | string | Uint8Array |
addHandle
Add handle to summary
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 |
addTree
Add tree to summary
Signature
addTree(key: string, summary: ISummaryTree): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | |
| summary | ISummaryTree |