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 reported to the callbacks registered with
onEditorError(), - 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
logWarning()andlogError()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'
} );Properties
context: object | null | undefinedreadonlymodule:utils/ckeditorerror~CKEditorError#contextA context of the error by which error reporting works out which editor the error came from.
data?: objectreadonlymodule:utils/ckeditorerror~CKEditorError#dataThe additional error data passed to the constructor. Undefined if none was passed.
Methods
constructor( errorName, context?, data?, originalError? )module:utils/ckeditorerror~CKEditorError#constructorCreates an instance of the CKEditorError class.
Parameters
errorName: stringThe error id in an
error-nameformat. A link to this error documentation page will be added to the thrown error'smessage.context?: object | nullA context of the error by which error reporting works out which editor the error came from. Pass the editor, the context, or the plugin or command that throws the error. Pass
nullif the error should not be attributed to any editor (e.g. during the editor initialization).data?: objectAdditional 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
dataproperty.originalError?: ErrorAn optional original error that is being wrapped in the
CKEditorErrorinstance.
is( type ) → booleanmodule:utils/ckeditorerror~CKEditorError#isChecks if the error is of the
CKEditorErrortype.Parameters
type: string
Returns
boolean
Static methods
rethrowUnexpectedError( error, context ) → neverstaticmodule:utils/ckeditorerror~CKEditorError.rethrowUnexpectedErrorA utility that ensures that the thrown error is a
CKEditorErrorone. Only aCKEditorErroris reported to the callbacks registered withonEditorError(), so wrapping an unexpected error in one is what makes it reach them.Parameters
error: ErrorThe error to rethrow.
context: objectAn object connected through properties with the editor instance. This context is what error reporting uses to work out which editor the error came from.
Returns
never