FileDocumentServiceFactory Class

Packages > @fluidframework/file-driver > FileDocumentServiceFactory

Factory for creating the file document service. Use this if you want to use the local file storage as underlying storage.

Signature:

export declare class FileDocumentServiceFactory implements IDocumentServiceFactory 

Implements: IDocumentServiceFactory

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(storage, deltaStorage, deltaConnection) Constructs a new instance of the FileDocumentServiceFactory class

Properties

List of properties for this class
Property Modifiers Type Description
protocolName (not declared)

Methods

List of methods on this class
Method Modifiers Description
createContainer(createNewSummary, resolvedUrl, logger)
createDocumentService(fileURL, logger) Creates the file document service if the path exists.

Constructors

FileDocumentServiceFactory.(constructor)

Constructs a new instance of the FileDocumentServiceFactory class

Signature:

constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);

Parameters

List of parameters
Parameter Type Description
storage IDocumentStorageService
deltaStorage FileDeltaStorageService
deltaConnection IDocumentDeltaConnection

Properties

protocolName

Signature:

readonly protocolName = "fluid-file:";

Methods

createContainer

Signature:

createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;

Parameters

List of parameters
Parameter Type Description
createNewSummary ISummaryTree
resolvedUrl IResolvedUrl
logger ITelemetryBaseLogger

Returns:

Promise<IDocumentService>

createDocumentService

Creates the file document service if the path exists.

Signature:

createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;

Parameters

List of parameters
Parameter Type Description
fileURL IResolvedUrl Path of directory containing ops/snapshots.
logger ITelemetryBaseLogger

Returns:

Promise<IDocumentService>

file document service.