Skip to main content
Version: v1

SnapshotExtractor Class

Signature​

export declare abstract class SnapshotExtractor

Properties​

Property Type Description
aggregatedBlobName
virtualIdCounter number
virtualIdPrefix

Methods​

Method Return Type Description
getBlob(id, tree) Promise<ArrayBufferLike>
getNextVirtualId() string
setBlob(id, tree, content) any
unpackSnapshotCore(snapshot, level) Promise<void>

Property Details​

aggregatedBlobName​

Signature​
protected readonly aggregatedBlobName = "__big";

virtualIdCounter​

Signature​
protected virtualIdCounter: number;

Type: number

virtualIdPrefix​

Signature​
protected readonly virtualIdPrefix = "__";

Method Details​

getBlob​

Signature​
abstract getBlob(id: string, tree: ISnapshotTree): Promise<ArrayBufferLike>;

Parameters​

Parameter Type Description
id string
tree ISnapshotTree

Returns​

Return type: Promise<ArrayBufferLike>

getNextVirtualId​

Signature​
protected getNextVirtualId(): string;

Returns​

Return type: string

setBlob​

Signature​
abstract setBlob(id: string, tree: ISnapshotTree, content: string): any;

Parameters​

Parameter Type Description
id string
tree ISnapshotTree
content string

Returns​

Return type: any

unpackSnapshotCore​

Signature​
unpackSnapshotCore(snapshot: ISnapshotTree, level?: number): Promise<void>;

Parameters​

Parameter Modifiers Type Description
snapshot ISnapshotTree
level optional number

Returns​

Return type: Promise<void>