SnapshotExtractor Class

Packages > @fluidframework/driver-utils > SnapshotExtractor

Signature:

export declare abstract class SnapshotExtractor 

Properties

List of properties for this class
Property Modifiers Type Description
aggregatedBlobName (not declared)
virtualIdCounter number
virtualIdPrefix (not declared)

Methods

List of methods on this class
Method Modifiers Description
getBlob(id, tree)
getNextVirtualId()
setBlob(id, tree, content)
unpackSnapshotCore(snapshot, level)

Properties

aggregatedBlobName

Signature:

protected readonly aggregatedBlobName = "__big";

virtualIdCounter

Signature:

protected virtualIdCounter: number;

virtualIdPrefix

Signature:

protected readonly virtualIdPrefix = "__";

Methods

getBlob

Signature:

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

Parameters

List of parameters
Parameter Type Description
id string
tree ISnapshotTree

Returns:

Promise<ArrayBufferLike>

getNextVirtualId

Signature:

protected getNextVirtualId(): string;

Returns:

string

setBlob

Signature:

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

Parameters

List of parameters
Parameter Type Description
id string
tree ISnapshotTree
content string

Returns:

any

unpackSnapshotCore

Signature:

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

Parameters

List of parameters
Parameter Type Description
snapshot ISnapshotTree
level number

Returns:

Promise<void>