ComPDFKit Web SDK
    Preparing search index...

    Class EventHandler<E>

    Base class for objects that fire named events. Listener arguments are passed by position.

    Type Parameters

    • E extends EventMap<E> = Record<string, unknown[]>

    Hierarchy (View Summary)

    Index
    • Type Parameters

      • E extends EventMap<E> = Record<string, unknown[]>

      Returns EventHandler<E>

    • Adds a listener for an event. Adding the same function twice for one event has no effect.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Event name.

      • fn: (...args: E[K]) => void

        Listener, called with the event arguments.

      • Optionaloptions: { once?: boolean }

        Listener options.

        • Optionalonce?: boolean

          When true, the listener is removed after it runs once.

      Returns void

    • Removes every listener of every event.

      Returns void

    • Removes a listener, or every listener of the event when fn is omitted.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Event name.

      • Optionalfn: (...args: E[K]) => void

        The function that was passed to addEventListener.

      Returns void

    • A listener that throws does not affect the others; the error is reported through logger.error.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K
      • Optionalargs: E[K]

      Returns void

    • Like trigger, but awaits the Promise returned by each listener in turn; a failing listener does not affect the others.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K
      • Optionalargs: E[K]

      Returns Promise<void>