OperationReplayer (engine/dev-utils)
@ckeditor/ckeditor5-engine/src/dev-utils/operationreplayer
Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
Filtering
Properties
-
private
_logSeparator : stringmodule:engine/dev-utils/operationreplayer~OperationReplayer#_logSeparator -
private
_operationsToReplay : Array<Operation>module:engine/dev-utils/operationreplayer~OperationReplayer#_operationsToReplay
Methods
-
constructor( model, logSeparator, stringifiedOperations )module:engine/dev-utils/operationreplayer~OperationReplayer#constructorParameters
model : ModelData model.
logSeparator : stringSeparator between operations.
stringifiedOperations : stringOperations to replay.
-
applyAllOperations() → Promise<void>module:engine/dev-utils/operationreplayer~OperationReplayer#applyAllOperations -
applyNextOperation() → Promise<boolean>module:engine/dev-utils/operationreplayer~OperationReplayer#applyNextOperationApplies the next operation to replay. Returns a promise with the
isFinishedparameter that istrueif the last operation in the replayer has been applied,falseotherwise.Returns
Promise<boolean>
-
applyOperations( numberOfOperations ) → undefined | Promise<void>module:engine/dev-utils/operationreplayer~OperationReplayer#applyOperationsApplies
numberOfOperationsoperations, beginning after the last applied operation (or first, if no operations were applied).Parameters
numberOfOperations : numberThe number of operations to apply.
Returns
undefined | Promise<void>
-
getOperationsToReplay() → Array<Operation>module:engine/dev-utils/operationreplayer~OperationReplayer#getOperationsToReplay -
play( timeInterval ) → Promise<void>module:engine/dev-utils/operationreplayer~OperationReplayer#playApplies all operations with a delay between actions.
Parameters
timeInterval : numberTime between applying operations.
Defaults to
1000
Returns
Promise<void>
-
setStringifiedOperations( stringifiedOperations ) → voidmodule:engine/dev-utils/operationreplayer~OperationReplayer#setStringifiedOperationsParses the given string containing stringified operations and sets parsed operations as operations to replay.
Parameters
stringifiedOperations : stringStringified operations to replay.
Returns
void
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.