Watchdog (watchdog)
@ckeditor/ckeditor5-watchdog/src/watchdog
An abstract watchdog class that handles most of the error handling process and the state of the underlying component.
See the Watchdog feature guide to learn the rationale behind it and how to use it.
Filtering
Properties
-
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,
-
state : WatchdogStatemodule:watchdog/watchdog~Watchdog#stateSpecifies 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 toinitializingorcrashedPermanentlydepending 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 callingwatchdog.destroy().
-
The watched item.
-
private
_boundErrorHandler : ( ErrorEvent | PromiseRejectionEvent ) => voidmodule:watchdog/watchdog~Watchdog#_boundErrorHandlerChecks if the event error comes from the underlying item and restarts the item.
-
-
private
_listeners : Record<string, Array<( any ) => void>>module:watchdog/watchdog~Watchdog#_listenersA dictionary of event emitter listeners.
-
private
_minimumNonErrorTimePeriod : numbermodule:watchdog/watchdog~Watchdog#_minimumNonErrorTimePeriod -
Returns the result of the
Date.now()call. It can be overridden in tests to mock time as some popular approaches likesinon.useFakeTimers()do not work well with error handling.
Methods
-
constructor( config )module:watchdog/watchdog~Watchdog#constructor -
destroy() → voidmodule:watchdog/watchdog~Watchdog#destroy -
off( eventName, callback ) → voidmodule:watchdog/watchdog~Watchdog#offStops listening to the specified event name by removing the callback from event listeners.
Note that this method differs from the CKEditor 5's default
EventEmitterMixinimplementation.Parameters
eventName : keyof EventMapThe event name.
callback : unknownA callback which will be removed from event listeners.
Returns
void
-
on( eventName, callback ) → voidmodule:watchdog/watchdog~Watchdog#onStarts 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
EventEmitterMixinimplementation.Type parameters
K : extends keyof EventMap
Parameters
eventName : KThe event name.
callback : EventCallback<K>A callback which will be added to event listeners.
Returns
void
-
internal
_isErrorComingFromThisItem( error ) → booleanmodule:watchdog/watchdog~Watchdog#_isErrorComingFromThisItemTraverses 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
-
-
-
-
Checks if an error comes from the watched item and restarts it. It reacts to
CKEditorErrorerrors only.Parameters
error : ErrorError.
evt : ErrorEvent | PromiseRejectionEventAn error event.
Returns
void
Fires
-
Checks whether an error should be handled by the watchdog.
Parameters
error : ErrorAn error that was caught by the error handling process.
Returns
boolean
-
Events
-
error( eventInfo, <anonymous> )module:watchdog/watchdog~Watchdog#event:errorFired when a new
CKEditorErrorerror 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 : EventInfoAn object containing information about the fired event.
<anonymous> : WatchdogErrorEventData
-
stateChange( eventInfo )module:watchdog/watchdog~Watchdog#event:stateChangeFired when the watchdog state changed.
Parameters
eventInfo : EventInfoAn object containing information about the fired event.
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.