ts-lambda-api - v2.5.3
    Preparing search index...

    Interface NodeEventTarget

    The NodeEventTarget is a Node.js-specific extension to EventTarget that emulates a subset of the EventEmitter API.

    v14.5.0

    interface NodeEventTarget {
        addEventListener(
            type: string,
            listener: EventListener | EventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addListener(type: string, listener: (arg: any) => void): this;
        dispatchEvent(event: Event): boolean;
        emit(type: string, arg: any): boolean;
        eventNames(): string[];
        getMaxListeners(): number;
        listenerCount(type: string): number;
        off(
            type: string,
            listener: (arg: any) => void,
            options?: EventListenerOptions,
        ): this;
        on(type: string, listener: (arg: any) => void): this;
        once(type: string, listener: (arg: any) => void): this;
        removeAllListeners(type?: string): this;
        removeEventListener(
            type: string,
            listener: EventListener | EventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeListener(
            type: string,
            listener: (arg: any) => void,
            options?: EventListenerOptions,
        ): this;
        setMaxListeners(n: number): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addEventListener addListener dispatchEvent emit eventNames getMaxListeners listenerCount off on once removeAllListeners removeEventListener removeListener setMaxListeners

    Methods

    • Node.js-specific extension to the EventTarget class that emulates the equivalent EventEmitter API. The only difference between addListener() and addEventListener() is that addListener() will return a reference to the EventTarget.

      Parameters

      • type: string
      • listener: (arg: any) => void

      Returns this

      v14.5.0

    • Parameters

      Returns boolean

    • Node.js-specific extension to the EventTarget class that dispatches the arg to the list of handlers for type.

      Parameters

      • type: string
      • arg: any

      Returns boolean

      true if event listeners registered for the type exist, otherwise false.

      v15.2.0

    • Node.js-specific extension to the EventTarget class that returns an array of event type names for which event listeners are registered.

      Returns string[]

      14.5.0

    • Node.js-specific extension to the EventTarget class that returns the number of max event listeners.

      Returns number

      v14.5.0

    • Node.js-specific extension to the EventTarget class that returns the number of event listeners registered for the type.

      Parameters

      • type: string

      Returns number

      v14.5.0

    • Node.js-specific alias for eventTarget.removeEventListener().

      Parameters

      Returns this

      v14.5.0

    • Node.js-specific alias for eventTarget.addEventListener().

      Parameters

      • type: string
      • listener: (arg: any) => void

      Returns this

      v14.5.0

    • Node.js-specific extension to the EventTarget class that adds a once listener for the given event type. This is equivalent to calling on with the once option set to true.

      Parameters

      • type: string
      • listener: (arg: any) => void

      Returns this

      v14.5.0

    • Node.js-specific extension to the EventTarget class. If type is specified, removes all registered listeners for type, otherwise removes all registered listeners.

      Parameters

      • Optionaltype: string

      Returns this

      v14.5.0

    • Node.js-specific extension to the EventTarget class that removes the listener for the given type. The only difference between removeListener() and removeEventListener() is that removeListener() will return a reference to the EventTarget.

      Parameters

      Returns this

      v14.5.0

    • Node.js-specific extension to the EventTarget class that sets the number of max event listeners as n.

      Parameters

      • n: number

      Returns void

      v14.5.0

    Settings

    Member Visibility

    On This Page

    Methods