Skip to main content
Version: v1

DocumentStorageService Class

Signature​

export declare class DocumentStorageService extends DocumentStorageServiceProxy

Extends: DocumentStorageServiceProxy

Constructors​

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

Properties​

PropertyModifiersTypeDescription
idstring
logTailShastring | undefined
managerGitManager
noCacheGitManageroptionalGitManager | undefined

Methods​

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

ParameterModifiersTypeDescription
idstring
managerGitManager
loggerITelemetryLogger
policiesoptionalIDocumentStorageServicePolicies
driverPoliciesoptionalIRouterliciousDriverPolicies
blobCacheoptionalICache<ArrayBufferLike>
snapshotTreeCacheoptionalICache<ISnapshotTreeVersion>
noCacheGitManageroptionalGitManager | undefined
getStorageManageroptional(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​

ParameterModifiersTypeDescription
versionoptionalIVersion

Returns​

Return type: Promise<ISnapshotTree | null>