CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

Batch (engine/model)

@ckeditor/ckeditor5-engine/src/model/batch

class
See source

A batch instance groups model changes (operations). All operations grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want to extend a given undo step, you can add more changes to the batch using enqueueChange:

model.enqueueChange( batch, writer => {
    writer.insertText( 'foo', paragraph, 'end' );
} );

Filtering

Properties

  • baseVersion : Number | null

    readonly

    Returns the base version of this batch, which is equal to the base version of the first operation in the batch. If there are no operations in the batch or neither operation has the base version set, it returns null.

    See source

  • operations : Array.<Operation>

    readonly

    An array of operations that compose this batch.

    See source

  • type : 'transparent' | 'default'

    readonly

    The type of the batch.

    See source

    It can be one of the following values:

    • 'default' – All "normal" batches. This is the most commonly used type.
    • 'transparent' – A batch that should be ignored by other features, i.e. an initial batch or collaborative editing changes.

Methods