@ckeditor/ckeditor5-watchdog

What is @ckeditor/ckeditor5-watchdog?

@ckeditor/ckeditor5-watchdog is a package designed to enhance the stability and reliability of CKEditor 5 by providing mechanisms to monitor and automatically recover from editor crashes. It ensures that the editor remains operational even in the face of unexpected errors.

What are @ckeditor/ckeditor5-watchdog's main functionalities?

Editor Watchdog

The Editor Watchdog monitors a single CKEditor 5 instance and automatically restarts it in case of a crash. This ensures that the editor remains available to the user.

const { EditorWatchdog } = require('@ckeditor/ckeditor5-watchdog');
const ClassicEditor = require('@ckeditor/ckeditor5-editor-classic/src/classiceditor');

const watchdog = new EditorWatchdog(ClassicEditor);

watchdog.create(document.querySelector('#editor'), {
    // Editor configuration.
}).catch(error => {
    console.error('Error initializing the editor:', error);
});

Context Watchdog

The Context Watchdog monitors a CKEditor 5 context, which can include multiple editor instances. It ensures that all editors within the context are restarted in case of a crash, maintaining the overall stability of the editing environment.

const { ContextWatchdog } = require('@ckeditor/ckeditor5-watchdog');
const Context = require('@ckeditor/ckeditor5-core/src/context');

const watchdog = new ContextWatchdog(Context);

watchdog.create({
    // Context configuration.
}).then(context => {
    // Create editors within the context.
}).catch(error => {
    console.error('Error initializing the context:', error);
});

Other packages similar to @ckeditor/ckeditor5-watchdog

react-error-boundary

react-error-boundary provides a reusable component for handling JavaScript errors in React components. It offers a way to catch errors in the component tree and display a fallback UI. While it is not specific to CKEditor, it serves a similar purpose of enhancing application stability by managing errors gracefully.

redux-saga

redux-saga is a library that aims to make application side effects (e.g., asynchronous actions) easier to manage, more efficient to execute, and better at handling failures. It provides mechanisms to handle errors and retries, which can be compared to the watchdog functionality in terms of ensuring application robustness.

raven-js

raven-js is the official browser JavaScript client for Sentry, a real-time crash reporting system. It captures and reports errors in web applications, providing insights into crashes and helping developers to fix issues. Similar to @ckeditor/ckeditor5-watchdog, it focuses on monitoring and recovering from errors.

README

CKEditor 5 watchdog feature

This package implements the watchdog feature for CKEditor 5. It keeps a CKEditor 5 rich-text editor instance running.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Documentation

See the @ckeditor/ckeditor5-watchdog package page as well as the Watchdog feature guide in CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.