CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/API
Class

CKEditorError (utils)

@ckeditor/ckeditor5-utils/src/ckeditorerror

class
See source

The CKEditor error class.

All errors will be shortened during the minification process in order to reduce the code size. Therefore, all error messages should be documented in the same way as those in log.

Read more in the log module.

Filtering

Properties

  • data : Object | undefined

    The additional error data passed to the constructor. Undefined if none was passed.

    See source

  • name : String

Methods

  • constructor( message, [ data ] )

    Creates an instance of the CKEditorError class.

    See source

    Read more about error logging in the log module.

    Parameters

    message : String

    The error message in an error-name: Error message. format. During the minification process the "Error message" part will be removed to limit the code size and a link to this error documentation will be added to the message.

    [ data ] : Object

    Additional data describing the error. A stringified version of this object will be appended to the error message, so the data are quickly visible in the console. The original data object will also be later available under the data property.

Static methods

  • isCKEditorError( error ) → Boolean

    static

    Checks if error is an instance of CKEditorError class.

    See source

    Parameters

    error : Object

    Object to check.

    Returns

    Boolean