FileDeltaStorageService Class

Packages > @fluidframework/file-driver > FileDeltaStorageService

Provides access to the underlying delta storage on the local file storage for file driver.

Signature:

export declare class FileDeltaStorageService implements IDocumentDeltaStorageService 

Implements: IDocumentDeltaStorageService

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(path) Constructs a new instance of the FileDeltaStorageService class

Properties

List of properties for this class
Property Modifiers Type Description
ops readonly ReadonlyISequencedDocumentMessage>[]

Methods

List of methods on this class
Method Modifiers Description
get(from, to)
getFromWebSocket(from, to) Retrieve ops within the exclusive sequence number range.

Constructors

FileDeltaStorageService.(constructor)

Constructs a new instance of the FileDeltaStorageService class

Signature:

constructor(path: string);

Parameters

List of parameters
Parameter Type Description
path string

Properties

ops

Signature:

get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];

Methods

get

Signature:

get(from?: number, to?: number): Promise<IDeltasFetchResult>;

Parameters

List of parameters
Parameter Type Description
from number
to number

Returns:

Promise<IDeltasFetchResult>

getFromWebSocket

Retrieve ops within the exclusive sequence number range.

Signature:

getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];

Parameters

List of parameters
Parameter Type Description
from number First op to be fetched.
to number Last op to be fetched. This is exclusive.

Returns:

api.ISequencedDocumentMessage[]