Watchdog

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,

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 watched item.

Checks if the event error comes from the underlying item and restarts the item.

Related:

• WatchdogConfig

A dictionary of event emitter listeners.

Related:

• WatchdogConfig

Returns the result of the Date.now() call. It can be overridden in tests to mock time as some popular approaches like sinon.useFakeTimers() do not work well with error handling.

Parameters

config : WatchdogConfig

The watchdog plugin configuration.

Destroys the watchdog and releases the resources.

Returns

void

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

Traverses the error context and the watched item to find out whether the error should be handled by the given item.

Parameters

error : CKEditorError

Returns

boolean

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

The method responsible for restarting the watched item.

Returns

Promise<unknown>

Starts error handling by attaching global error handlers.

Returns

void

Stops error handling by detaching global error handlers.

Returns

void

Checks if an error comes from the watched item and restarts it. It reacts to CKEditorError errors only.

Parameters

error : Error

Error.

evt : ErrorEvent | PromiseRejectionEvent

An error event.

Returns

void

Fires

• error

Checks whether an error should be handled by the watchdog.

Parameters

error : Error

An error that was caught by the error handling process.

Returns

boolean

Checks if the watchdog should restart the underlying item.

Returns

boolean

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 when the watchdog state changed.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.