ActionsRecorderConfig

interface

The configuration of the ActionsRecorder plugin.

	ClassicEditor
		.create( editorElement, {
			actionsRecorder: ... // ActionsRecorder feature options.
		} )
		.then( ... )
		.catch( ... );

See all editor configuration options.

See source

Properties

maxEntries : number | undefined

module:watchdog/actionsrecorderconfig~ActionsRecorderConfig#maxEntries
The maximum number of action entries to keep in memory. When this limit is reached, older entries will be removed.

This behavior can be modified by providing onMaxEntries callback.
```
	ClassicEditor
		.create( editorElement, {
			plugins: [ ActionsRecorder, ... ],
			actionsRecorder: {
				maxEntries: 1000
			}
		} )
		.then( ... )
		.catch( ... );
```
Copy code
See source (with github icon)

Defaults to 1000

`onError : ActionsRecorderErrorCallback | undefined`

module:watchdog/actionsrecorderconfig~ActionsRecorderConfig#onError

Callback function called on caught error.

	ClassicEditor
		.create( editorElement, {
			plugins: [ ActionsRecorder, ... ],
			actionsRecorder: {
				onError( error, entries ) {
					console.error( 'ActionsRecorder - Error detected:', error );
					console.warn( 'Actions recorded before error:', entries );

					this.flushEntries();
				}
			}
		} )
		.then( ... )
		.catch( ... );

See source

onFilter : ActionsRecorderFilterCallback | undefined

module:watchdog/actionsrecorderconfig~ActionsRecorderConfig#onFilter
Filter function that determines whether a record should be added to the list. This is called before the action executes and before the entry is stored. It allows to reduce memory usage by filtering out unnecessary records.

If this function returns false, the record will not be stored in the entries array.
```
	ClassicEditor
		.create( editorElement, {
			plugins: [ ActionsRecorder, ... ],
			actionsRecorder: {
				onFilter( entry, prevEntries ) {
					// Only record command executions.
					return entry.action.startsWith( 'commands.' );
				}
			}
		} )
		.then( ... )
		.catch( ... );
```
Copy code
See source (with github icon)
onMaxEntries : ActionsRecorderMaxEntriesCallback | undefined

module:watchdog/actionsrecorderconfig~ActionsRecorderConfig#onMaxEntries
Callback function called when recorded entries count reaches maxEntries.
```
	ClassicEditor
		.create( editorElement, {
			plugins: [ ActionsRecorder, ... ],
			actionsRecorder: {
				onMaxEntries() {
					const entries = this.getEntries();

					this.flushEntries();

					console.log( 'ActionsRecorder - Batch of entries:', entries );
				}
			}
		} )
		.then( ... )
		.catch( ... );
```
Copy code
By default, when this callback is not provided, the list of entries is shifted so it does not include more than maxEntries.

See source (with github icon)

ActionsRecorderConfig

Properties

`maxEntries : number | undefined`

`onError : ActionsRecorderErrorCallback | undefined`

`onFilter : ActionsRecorderFilterCallback | undefined`

`onMaxEntries : ActionsRecorderMaxEntriesCallback | undefined`