SnapshotLegacy Class
Signature
export declare class SnapshotLegacy
Constructors
| Constructor | Description |
|---|---|
| (constructor)(mergeTree, logger, filename, onCompletion) | Constructs a new instance of the SnapshotLegacy class |
Static Properties
| Property | Type | Description |
|---|---|---|
| body | ||
| header | ||
| sizeOfFirstChunk | number |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| filename | optional | string | undefined | |
| mergeTree | MergeTree | ||
| onCompletion | optional | (() => void) | undefined |
Methods
| Method | Return Type | Description |
|---|---|---|
| emit(catchUpMsgs, serializer, bind) | ISummaryTreeWithStats | Emits the snapshot to an ISummarizeResult. If provided the optional IFluidSerializer will be used when serializing the summary data rather than JSON.stringify. |
| extractSync() | IJSONSegment[] |
Constructor Details
(constructor)
Constructs a new instance of the SnapshotLegacy class
Signature
constructor(mergeTree: MergeTree, logger: ITelemetryLogger, filename?: string | undefined, onCompletion?: (() => void) | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| mergeTree | MergeTree | ||
| logger | ITelemetryLogger | ||
| filename | optional | string | undefined | |
| onCompletion | optional | (() => void) | undefined |
Property Details
body
Signature
static readonly body = "body";
filename
Signature
filename?: string | undefined;
Type: string | undefined
header
Signature
static readonly header = "header";
mergeTree
Signature
mergeTree: MergeTree;
Type: MergeTree
onCompletion
Signature
onCompletion?: (() => void) | undefined;
Type: (() => void) | undefined
sizeOfFirstChunk
Signature
static readonly sizeOfFirstChunk: number;
Type: number
Method Details
emit
Emits the snapshot to an ISummarizeResult. If provided the optional IFluidSerializer will be used when serializing the summary data rather than JSON.stringify.
Signature
emit(catchUpMsgs: ISequencedDocumentMessage[], serializer: IFluidSerializer, bind: IFluidHandle): ISummaryTreeWithStats;
Parameters
| Parameter | Type | Description |
|---|---|---|
| catchUpMsgs | ISequencedDocumentMessage[] | |
| serializer | IFluidSerializer | |
| bind | IFluidHandle |
Returns
Return type: ISummaryTreeWithStats
extractSync
Signature
extractSync(): IJSONSegment[];
Returns
Return type: IJSONSegment[]