Trilium Frontend API
    Preparing search index...

    Class CKEditorError

    The CKEditor error class.

    You should throw CKEditorError when:

    • An unexpected situation occurred and the editor (most probably) will not work properly. Such exception will be handled by the module:watchdog/watchdog~Watchdog watchdog (if it is integrated),
    • If the editor is incorrectly integrated or the editor API is used in the wrong way. This way you will give feedback to the developer as soon as possible. Keep in mind that for common integration issues which should not stop editor initialization (like missing upload adapter, wrong name of a toolbar component) we use module:utils/ckeditorerror~logWarning logWarning() and module:utils/ckeditorerror~logError logError() to improve developers experience and let them see the a working editor as soon as possible.
    /**
     * Error thrown when a plugin cannot be loaded due to JavaScript errors, lack of plugins with a given name, etc.
     *
     * @error plugin-load
     * @param pluginName The name of the plugin that could not be loaded.
     * @param moduleName The name of the module which tried to load this plugin.
     */
    throw new CKEditorError( 'plugin-load', {
    	pluginName: 'foo',
    	moduleName: 'bar'
    } );

    Hierarchy

    • Error
      • CKEditorError
    Index

    Constructors

    constructor

    Properties

    cause? context data? message name stack? stackTraceLimit

    Methods

    is captureStackTrace prepareStackTrace rethrowUnexpectedError

    Constructors

    • Creates an instance of the CKEditorError class.

      Parameters

      • errorName: string

        The error id in an error-name format. A link to this error documentation page will be added to the thrown error's message.

      • Optionalcontext: object

        A context of the error by which the module:watchdog/watchdog~Watchdog watchdog is able to determine which editor crashed. It should be an editor instance or a property connected to it. It can be also a null value if the editor should not be restarted in case of the error (e.g. during the editor initialization). The error context should be checked using the areConnectedThroughProperties( editor, context ) utility to check if the object works as the context.

      • Optionaldata: 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.

      • OptionaloriginalError: Error

        An optional original error that is being wrapped in the CKEditorError instance.

      Returns CKEditorError

    Properties

    cause?: unknown
    context: object

    A context of the error by which the Watchdog is able to determine which editor crashed.

    data?: object

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

    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Checks if the error is of the CKEditorError type.

      Parameters

      • type: string

      Returns boolean

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • A utility that ensures that the thrown error is a module:utils/ckeditorerror~CKEditorError one. It is useful when combined with the module:watchdog/watchdog~Watchdog feature, which can restart the editor in case of a module:utils/ckeditorerror~CKEditorError error.

      Parameters

      • error: Error

        The error to rethrow.

      • context: object

        An object connected through properties with the editor instance. This context will be used by the watchdog to verify which editor should be restarted.

      Returns never

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods