@fluidframework/file-driver Package
Packages > @fluidframework/file-driver
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 |
Functions
Function | Description |
---|---|
FileSnapshotWriterClassFactory(Base) |
Interfaces
Interface | Description |
---|---|
ISnapshotWriterStorage |
Variables
Variable | Description |
---|---|
FileStorageDocumentName | |
FluidFetchReaderFileSnapshotWriter |
Type Aliases
Type Alias | Description |
---|---|
ReaderConstructor |
Functions
FileSnapshotWriterClassFactory
Signature:
export declare function FileSnapshotWriterClassFactory<TBase extends ReaderConstructor>(Base: TBase): {
new (...args: any[]): {
blobsWriter: Map<string, string>;
commitsWriter: {
[key: string]: api.ITree;
};
latestWriterTree?: api.ISnapshotTree | undefined;
docId?: string | undefined;
reset(): void;
onCommitHandler(dataStoreName: string, tree: api.ITree): void;
onSnapshotHandler(snapshot: IFileSnapshot): void;
read(sha: string): Promise<string>;
readBlob(sha: string): Promise<ArrayBuffer | SharedArrayBuffer>;
getVersions(versionId: string, count: number): Promise<api.IVersion[]>;
getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>;
write(tree: api.ITree, parents: string[], message: string, ref: string): Promise<api.IVersion>;
writeOutFullSnapshot(tree: api.ITree): Promise<void>;
sortTree(tree: api.ITree): void;
buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
repositoryUrl: string;
createBlob(file: ArrayBuffer | SharedArrayBuffer): Promise<api.ICreateBlobResponse>;
uploadSummaryWithContext(summary: api.ISummaryTree, context: import("@fluidframework/driver-definitions").ISummaryContext): Promise<string>;
downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
};
} & TBase;
Parameters
Parameter | Type | Description |
---|---|---|
Base | TBase |
Returns:
{ new (…args: any[]): { blobsWriter: Map<string, string>; commitsWriter: { [key: string]: api.ITree; }; latestWriterTree?: api.ISnapshotTree | undefined; docId?: string | undefined; reset(): void; onCommitHandler(dataStoreName: string, tree: api.ITree): void; onSnapshotHandler(snapshot: IFileSnapshot): void; read(sha: string): Promise<string>; readBlob(sha: string): Promise<ArrayBuffer | SharedArrayBuffer>; getVersions(versionId: string, count: number): Promise<api.IVersion[]>; getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>; write(tree: api.ITree, parents: string[], message: string, ref: string): Promise<api.IVersion>; writeOutFullSnapshot(tree: api.ITree): Promise<void>; sortTree(tree: api.ITree): void; buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>; repositoryUrl: string; createBlob(file: ArrayBuffer | SharedArrayBuffer): Promise<api.ICreateBlobResponse>; uploadSummaryWithContext(summary: api.ISummaryTree, context: import("@fluidframework/driver-definitions").ISummaryContext): Promise<string>; downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>; }; } & TBase
Variables
FileStorageDocumentName
Signature:
FileStorageDocumentName = "FileStorageDocId"
FluidFetchReaderFileSnapshotWriter
Signature:
FluidFetchReaderFileSnapshotWriter: {
new (...args: any[]): {
blobsWriter: Map<string, string>;
commitsWriter: {
[key: string]: api.ITree;
};
latestWriterTree?: api.ISnapshotTree | undefined;
docId?: string | undefined;
reset(): void;
onCommitHandler(dataStoreName: string, tree: api.ITree): void;
onSnapshotHandler(snapshot: IFileSnapshot): void;
read(sha: string): Promise<string>;
readBlob(sha: string): Promise<ArrayBuffer | SharedArrayBuffer>;
getVersions(versionId: string, count: number): Promise<api.IVersion[]>;
getSnapshotTree(version?: api.IVersion | undefined): Promise<api.ISnapshotTree | null>;
write(tree: api.ITree, parents: string[], message: string, ref: string): Promise<api.IVersion>;
writeOutFullSnapshot(tree: api.ITree): Promise<void>;
sortTree(tree: api.ITree): void;
buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
repositoryUrl: string;
createBlob(file: ArrayBuffer | SharedArrayBuffer): Promise<api.ICreateBlobResponse>;
uploadSummaryWithContext(summary: api.ISummaryTree, context: import("@fluidframework/driver-definitions").ISummaryContext): Promise<string>;
downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
};
} & typeof FluidFetchReader
Type Aliases
ReaderConstructor
Signature:
export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;