Trilium Frontend API
    Preparing search index...

    Class WatchdogAbstract Internal

    An abstract watchdog class that handles most of the error handling process and the state of the underlying component.

    See the {@glink features/watchdog Watchdog feature guide} to learn the rationale behind it and how to use it.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    crashes: {
        colno?: number;
        date: number;
        filename?: string;
        lineno?: number;
        message: string;
        stack?: string;
    }[]

    An array of crashes saved as an object with the following properties:

    • message: String,
    • stack: String,
    • date: Number,
    • filename: String | undefined,
    • lineno: Number | undefined,
    • colno: Number | undefined,

    Specifies the state of the item watched by the watchdog. The state can be one of the following values:

    • initializing – Before the first initialization, and after crashes, before the item is ready.
    • ready – A state when the user can interact with the item.
    • crashed – A state when an error occurs. It quickly changes to initializing or crashedPermanently depending on how many and how frequent errors have been caught recently.
    • crashedPermanently – A state when the watchdog stops reacting to errors and keeps the item it is watching crashed,
    • destroyed – A state when the item is manually destroyed by the user after calling watchdog.destroy().

    Accessors

    • get _item(): unknown
      Internal

      The watched item.

      Returns unknown

    Methods

    • Fires an event with a given event name and arguments.

      Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

      Type Parameters

      Parameters

      Returns void

    • Internal

      Traverses the error context and the watched item to find out whether the error should be handled by the given item.

      Parameters

      Returns boolean

    • The method responsible for restarting the watched item.

      Returns Promise<unknown>

    • Starts error handling by attaching global error handlers.

      Returns void

    • Stops error handling by detaching global error handlers.

      Returns void

    • Destroys the watchdog and releases the resources.

      Returns void

    • Stops listening to the specified event name by removing the callback from event listeners.

      Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

      Parameters

      • eventName: keyof WatchdogEventMap

        The event name.

      • callback: unknown

        A callback which will be removed from event listeners.

      Returns void

    • Starts listening to a specific event name by registering a callback that will be executed whenever an event with a given name fires.

      Note that this method differs from the CKEditor 5's default EventEmitterMixin implementation.

      Type Parameters

      Parameters

      Returns void