Skip to main content
Version: v1

SnapshotExtractor Class

Signature​

export declare abstract class SnapshotExtractor

Properties​

PropertyTypeDescription
aggregatedBlobName
virtualIdCounternumber
virtualIdPrefix

Methods​

MethodReturn TypeDescription
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​

ParameterTypeDescription
idstring
treeISnapshotTree

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​

ParameterTypeDescription
idstring
treeISnapshotTree
contentstring

Returns​

Return type: any

unpackSnapshotCore​

Signature​

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

Parameters​

ParameterModifiersTypeDescription
snapshotISnapshotTree
leveloptionalnumber

Returns​

Return type: Promise<void>