engine/dev-utils/enableenginedebug

@ckeditor/ckeditor5-engine/src/dev-utils/enableenginedebug

Classes

• DebugPluginmodule:engine/dev-utils/enableenginedebug~DebugPlugin

  Plugin that enables debugging features on the editor's model and view documents.

  See source

Functions

• disableEngineDebug()module:engine/dev-utils/enableenginedebug.disableEngineDebug

  static

  Restores all methods that have been overwritten.

  See source

• enableEngineDebug( [ _logger ] ) → DebugPluginmodule:engine/dev-utils/enableenginedebug.enableEngineDebug

  static

  Enhances model classes with logging methods. Returns a plugin that should be loaded in the editor to enable debugging features.

  See source

  Every operation applied on model.Document is logged.

  The following classes are expanded with log and meaningful toString methods:

  • model.Position,
  • model.Range,
  • model.Text,
  • model.Element,
  • model.RootElement,
  • model.DocumentFragment,
  • model.Document,
  • all operations
  • view.Element,
  • view.DocumentFragment,
  • view.Document.

  Additionally, the following logging utility methods are added:

  • model.Text logExtended,
  • model.Element logExtended,
  • model.Element logAll.

  Additionally, the following classes are expanded with logTree and printTree methods:

  • model.Element,
  • model.DocumentFragment,
  • view.Element,
  • view.DocumentFragment.

  Finally, the following methods are added to Editor: logModel, logView, logDocuments. All those methods take one parameter, which is the version of the model document for which the model or view document state should be logged.

  Parameters

  [ _logger ] : Object

  An object with functions used to log messages and errors. By default messages are logged to the console. If specified, it is expected to have log() and error() methods.

  Returns

  DebugPlugin

  The plugin to be loaded into the editor.