EditorWatchdog

An array of crashes saved as an object with the following properties:

• message: String,
• stack: String,
• date: Number,
• filename: String | undefined,
• lineno: Number | undefined,
• colno: Number | undefined,

The current editor instance.

Specifies the state of the item watched by the watchdog. The state can be one of the following values:

• initializing – Before the first initialization, and after crashes, before the item is ready.
• ready – A state when the user can interact with the item.
• crashed – A state when an error occurs. It quickly changes to initializing or crashedPermanently depending on how many and how frequent errors have been caught recently.
• crashedPermanently – A state when the watchdog stops reacting to errors and keeps the item it is watching crashed,
• destroyed – A state when the item is manually destroyed by the user after calling watchdog.destroy().

The creation method.

Related:

• EditorWatchdog#setCreator

The destruction method.

Related:

• EditorWatchdog#setDestructor

The editor configuration.

The latest saved editor data represented as a root name -> root data object.

The latest record of the editor editable elements. Used to restart the editor.

The current editor instance.

The editor source element or data.

Specifies whether the editor was initialized using document data (true) or HTML elements (false).

The last document version.

A promise associated with the life cycle of the editor (creation or destruction processes).

It is used to prevent the initialization of the editor if the previous instance has not been destroyed yet, and conversely, to prevent the destruction of the editor if it has not been initialized.

Throttled save method. The save() method is called the specified saveInterval after throttledSave() is called, unless a new action happens in the meantime.

Type parameters

TEditor : extends Editor

Parameters

Editor : null | object

The editor class.

Properties

Editor.create : Promise<TEditor>

watchdogConfig : WatchdogConfig

The watchdog plugin configuration.

Defaults to {}

Creates the editor instance and keeps it running, using the defined creator and destructor.

Parameters

elementOrData : string | HTMLElement | Record<string, string> | Record<string, HTMLElement>

The editor source element or the editor data.

Defaults to ...

config : EditorConfig

The editor configuration.

Defaults to ...

[ context ] : Context

A context for the editor.

Returns

Promise<unknown>

Destroys the watchdog and the current editor instance. It fires the callback registered in setDestructor() and uses it to destroy the editor instance. It also sets the state to destroyed.

Returns

Promise<unknown>

Stops listening to the specified event name by removing the callback from event listeners.

Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

Parameters

eventName : keyof WatchdogEventMap

The event name.

callback : unknown

A callback which will be removed from event listeners.

Returns

void

Starts listening to a specific event name by registering a callback that will be executed whenever an event with a given name fires.

Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

Type parameters

K : extends keyof WatchdogEventMap

Parameters

eventName : K

The event name.

callback : WatchdogEventCallback<K>

A callback which will be added to event listeners.

Returns

void

Sets the function that is responsible for the editor creation. It expects a function that should return a promise.

watchdog.setCreator( ( element, config ) => ClassicEditor.create( element, config ) );

Parameters

creator : EditorWatchdogCreatorFunction<TEditor>

Returns

void

Sets the function that is responsible for the editor destruction. Overrides the default destruction function, which destroys only the editor instance. It expects a function that should return a promise or undefined.

watchdog.setDestructor( editor => {
	// Do something before the editor is destroyed.

	return editor
		.destroy()
		.then( () => {
			// Do something after the editor is destroyed.
		} );
} );

Parameters

destructor : ( editor: Editor ) => Promise<unknown>

Returns

void

Traverses the error context and the current editor to find out whether these structures are connected to each other via properties.

Parameters

error : CKEditorError

Returns

boolean

Parameters

props : Set<unknown>

Returns

void

Fires an event with a given event name and arguments.

Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

Type parameters

K : extends keyof WatchdogEventMap

Parameters

eventName : K

args : WatchdogEventArgs<K>

Returns

void

Restarts the editor instance. This method is called whenever an editor error occurs. It fires the restart event and changes the state to initializing.

Returns

Promise<unknown>

Fires

• restart

Starts error handling by attaching global error handlers.

Returns

void

Stops error handling by detaching global error handlers.

Returns

void

Clones the editor configuration.

Parameters

config : EditorConfig

Returns

EditorConfig

Returns

Promise<unknown>

Gets all data that is required to reinitialize editor instance.

Returns

EditorData

For each attached model root, returns its HTML editable element (if available).

Returns

Record<string, HTMLElement>

Saves the editor data, so it can be restored after the crash even if the data cannot be fetched at the moment of the crash.

Returns

void

Fired when a new CKEditorError error connected to the watchdog instance occurs and the watchdog will react to it.

watchdog.on( 'error', ( evt, { error, causesRestart } ) => {
	console.log( 'An error occurred.' );
} );

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : WatchdogErrorEventData

Fired after the watchdog restarts the error in case of a crash.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

Fired when the watchdog state changed.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.