Skip to main content
Version: v1

Replayer Class

Replay service used to play ops using the delta connection.

Signature​

export declare class Replayer

Constructors​

ConstructorDescription
(constructor)(deltaConnection, documentStorageService)Constructs a new instance of the Replayer class

Properties​

PropertyTypeDescription
currentReplayedOpnumber
opsreadonly Readonly<ISequencedDocumentMessage>[]

Methods​

MethodReturn TypeDescription
replay(replayTo)numberReplay the ops upto a certain number.

Constructor Details​

(constructor)​

Constructs a new instance of the Replayer class

Signature​

constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);

Parameters​

ParameterTypeDescription
deltaConnectionReplayFileDeltaConnection
documentStorageServiceFileDeltaStorageService

Property Details​

currentReplayedOp​

Signature​

get currentReplayedOp(): number;

set currentReplayedOp(op: number);

Type: number

ops​

Signature​

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

Type: readonly Readonly<ISequencedDocumentMessage>[]

Method Details​

replay​

Replay the ops upto a certain number.

Signature​

replay(replayTo: number): number;

Parameters​

ParameterTypeDescription
replayTonumberThe last op number to be replayed.

Returns​

Return type: number