Skip to main content
Version: v1

PrefetchDocumentStorageService Class

Signature​

export declare class PrefetchDocumentStorageService extends DocumentStorageServiceProxy

Extends: DocumentStorageServiceProxy

Properties​

Property Type Description
policies { caching: LoaderCachingPolicy; minBlobSize?: number | undefined; maximumCacheDurationMs?: number | undefined; } | undefined

Methods​

Method Return Type Description
getSnapshotTree(version) Promise<ISnapshotTree | null>
readBlob(blobId) Promise<ArrayBufferLike>
stopPrefetch() void

Property Details​

policies​

Signature​

get policies(): {
        caching: LoaderCachingPolicy;
        minBlobSize?: number | undefined;
        maximumCacheDurationMs?: number | undefined;
    } | undefined;

Type: { caching: LoaderCachingPolicy; minBlobSize?: number | undefined; maximumCacheDurationMs?: number | undefined; } | undefined

Method Details​

getSnapshotTree​

Signature​

getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;

Parameters​

Parameter Modifiers Type Description
version optional IVersion

Returns​

Return type: Promise<ISnapshotTree | null>

readBlob​

Signature​

readBlob(blobId: string): Promise<ArrayBufferLike>;

Parameters​

Parameter Type Description
blobId string

Returns​

Return type: Promise<ArrayBufferLike>

stopPrefetch​

Signature​

stopPrefetch(): void;