CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

utils/ckeditorerror

@ckeditor/ckeditor5-utils/src/ckeditorerror

module

Filtering

Constants

  • DOCUMENTATION_URL : 'https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html'

    See source

    URL to the documentation with error codes.

Classes

Functions

  • logError( errorName, [ data ] ) → void

    See source

    Logs an error to the console with a properly formatted message and adds a link to the documentation. Use whenever you want to log an error to the console.

    /**
 * There was a problem processing the configuration of the toolbar. The item with the given
 * name does not exist, so it was omitted when rendering the toolbar.
 *
 * @error toolbarview-item-unavailable
 * @param {String} name The name of the component.
 */
 logError( 'toolbarview-item-unavailable', { name } );

    Note: In most cases logging a warning using logWarning is enough.

    See also CKEditorError for an explanation when to use each method.

    Parameters

    errorName : string

    The error name to be logged.

    [ data ] : object

    Additional data to be logged.

    Returns

    void

  • logWarning( errorName, [ data ] ) → void

    See source

    Logs a warning to the console with a properly formatted message and adds a link to the documentation. Use whenever you want to log a warning to the console.

    /**
 * There was a problem processing the configuration of the toolbar. The item with the given
 * name does not exist, so it was omitted when rendering the toolbar.
 *
 * @error toolbarview-item-unavailable
 * @param {String} name The name of the component.
 */
logWarning( 'toolbarview-item-unavailable', { name } );

    See also CKEditorError for an explanation when to throw an error and when to log a warning or an error to the console.

    Parameters

    errorName : string

    The error name to be logged.

    [ data ] : object

    Additional data to be logged.

    Returns

    void