@fluidframework/file-driver Package

Interfaces

Interface	Description
ISnapshotWriterStorage

Classes

Class	Description
FileDeltaStorageService	Provides access to the underlying delta storage on the local file storage for file driver.
FileDocumentService	The DocumentService manages the different endpoints for connecting to underlying storage for file document service.
FileDocumentServiceFactory	Factory for creating the file document service. Use this if you want to use the local file storage as underlying storage.
FluidFetchReader	Document storage service for the file driver.
Replayer	Replay service used to play ops using the delta connection.
ReplayFileDeltaConnection

Types

TypeAlias	Description
ReaderConstructor

Variables

Variable	Type	Description
FileSnapshotWriterClassFactory	<TBase extends ReaderConstructor>(Base: TBase) => { new (...args: any[]): { blobsWriter: Map<string, ArrayBufferLike>; latestWriterTree?: api.ISnapshotTree | undefined; docId?: string | undefined; reset(): void; onSnapshotHandler(snapshot: IFileSnapshot): void; readBlob(sha: string): Promise<ArrayBufferLike>; getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>; getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>; uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>; buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>; repositoryUrl: string; readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined; createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>; downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>; readonly disposed?: boolean | undefined; dispose?: ((error?: Error | undefined) => void) | undefined; }; } & TBase
FileStorageDocumentName
FluidFetchReaderFileSnapshotWriter	{ new (...args: any[]): { blobsWriter: Map<string, ArrayBufferLike>; latestWriterTree?: api.ISnapshotTree | undefined; docId?: string | undefined; reset(): void; onSnapshotHandler(snapshot: IFileSnapshot): void; readBlob(sha: string): Promise<ArrayBufferLike>; getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>; getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>; uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>; buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>; repositoryUrl: string; readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined; createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>; downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>; readonly disposed?: boolean | undefined; dispose?: ((error?: Error | undefined) => void) | undefined; }; } & typeof FluidFetchReader

Variable Details

FileSnapshotWriterClassFactory

Signature

FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
    new (...args: any[]): {
        blobsWriter: Map<string, ArrayBufferLike>;
        latestWriterTree?: api.ISnapshotTree | undefined;
        docId?: string | undefined;
        reset(): void;
        onSnapshotHandler(snapshot: IFileSnapshot): void;
        readBlob(sha: string): Promise<ArrayBufferLike>;
        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
        getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>;
        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
        repositoryUrl: string;
        readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined;
        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
        readonly disposed?: boolean | undefined;
        dispose?: ((error?: Error | undefined) => void) | undefined;
    };
} & TBase

Type: <TBase extends ReaderConstructor>(Base: TBase) => { new (...args: any[]): { blobsWriter: Map<string, ArrayBufferLike>; latestWriterTree?: api.ISnapshotTree | undefined; docId?: string | undefined; reset(): void; onSnapshotHandler(snapshot: IFileSnapshot): void; readBlob(sha: string): Promise<ArrayBufferLike>; getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>; getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>; uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>; buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>; repositoryUrl: string; readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined; createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>; downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>; readonly disposed?: boolean | undefined; dispose?: ((error?: Error | undefined) => void) | undefined; }; } & TBase

FileStorageDocumentName

Signature

FileStorageDocumentName = "FileStorageDocId"

FluidFetchReaderFileSnapshotWriter

Signature

FluidFetchReaderFileSnapshotWriter: {
    new (...args: any[]): {
        blobsWriter: Map<string, ArrayBufferLike>;
        latestWriterTree?: api.ISnapshotTree | undefined;
        docId?: string | undefined;
        reset(): void;
        onSnapshotHandler(snapshot: IFileSnapshot): void;
        readBlob(sha: string): Promise<ArrayBufferLike>;
        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
        getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>;
        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
        repositoryUrl: string;
        readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined;
        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
        readonly disposed?: boolean | undefined;
        dispose?: ((error?: Error | undefined) => void) | undefined;
    };
} & typeof FluidFetchReader

Type: { new (...args: any[]): { blobsWriter: Map<string, ArrayBufferLike>; latestWriterTree?: api.ISnapshotTree | undefined; docId?: string | undefined; reset(): void; onSnapshotHandler(snapshot: IFileSnapshot): void; readBlob(sha: string): Promise<ArrayBufferLike>; getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>; getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>; uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>; buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>; repositoryUrl: string; readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined; createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>; downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>; readonly disposed?: boolean | undefined; dispose?: ((error?: Error | undefined) => void) | undefined; }; } & typeof FluidFetchReader