Skip to main content
Version: v1

DocumentStorageService Class

Signature

export declare class DocumentStorageService extends DocumentStorageServiceProxy

Extends: DocumentStorageServiceProxy

Constructors

Constructor Description
(constructor)(id, manager, logger, policies, driverPolicies, blobCache, snapshotTreeCache, noCacheGitManager, getStorageManager) Constructs a new instance of the DocumentStorageService class

Properties

Property Modifiers Type Description
id string
logTailSha string | undefined
manager GitManager
noCacheGitManager optional GitManager | undefined

Methods

Method Return Type Description
getSnapshotTree(version) Promise<ISnapshotTree | null>

Constructor Details

(constructor)

Constructs a new instance of the DocumentStorageService class

Signature

constructor(id: string, manager: GitManager, logger: ITelemetryLogger, policies?: IDocumentStorageServicePolicies, driverPolicies?: IRouterliciousDriverPolicies, blobCache?: ICache<ArrayBufferLike>, snapshotTreeCache?: ICache<ISnapshotTreeVersion>, noCacheGitManager?: GitManager | undefined, getStorageManager?: (disableCache?: boolean) => Promise<GitManager>);

Parameters

Parameter Modifiers Type Description
id string
manager GitManager
logger ITelemetryLogger
policies optional IDocumentStorageServicePolicies
driverPolicies optional IRouterliciousDriverPolicies
blobCache optional ICache<ArrayBufferLike>
snapshotTreeCache optional ICache<ISnapshotTreeVersion>
noCacheGitManager optional GitManager | undefined
getStorageManager optional (disableCache?: boolean) => Promise<GitManager>

Property Details

id

Signature

readonly id: string;

Type: string

logTailSha

Signature

get logTailSha(): string | undefined;

Type: string | undefined

manager

Signature

manager: GitManager;

Type: GitManager

noCacheGitManager

Signature

noCacheGitManager?: GitManager | undefined;

Type: GitManager | 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>