Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Emitter<EventTypes>

Type parameters

  • EventTypes: string | symbol

Hierarchy

Index

Interfaces

Properties

Methods

Properties

_barriers

_barriers: Barriers

_lookups

_lookups: Lookups

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener(event: EventTypes, fn: ListenerFn, context?: any): this

  • Parameters

    • event: EventTypes
    • fn: ListenerFn
    • Optional context: any

    Returns this

all

  • all(events: string[], callback: function, context?: any): this

  • Listen on a collection of events.

    Callbacks registered for a given collection will be invoked each time the member events have been emitted at least once. Note that the order of the member events is not significant.

    Callbacks are not invoked with arguments, however, data may be accessed from the store as normal.

    Parameters

    • events: string[]
    • callback: function
        • (): void

        • Returns void

    • Default value context: any = this

      The context to invoke the listener with.

    Returns this

allOff

  • allOff(events: string[], callback: function): this

  • Remove a callback for a given collection of events.

    The order of the member events is not significant.

    Parameters

    • events: string[]
    • callback: function
        • (): void

        • Returns void

    Returns this

emit

  • emit(event: string, ...args: any[]): boolean

  • Emit an event and an associated payload.

    Update the event collection counters and invoke the associated callbacks if required.

    Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<EventTypes>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventTypes>

generateKey

  • generateKey(events: string[]): string

listenerCount

  • listenerCount(event: EventTypes): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: EventTypes

    Returns number

listeners

  • listeners(event: EventTypes): Array<ListenerFn>

  • Return the listeners registered for a given event.

    Parameters

    • event: EventTypes

    Returns Array<ListenerFn>

off

  • off(event: EventTypes, fn?: ListenerFn, context?: any, once?: boolean): this

  • Parameters

    • event: EventTypes
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on(event: EventTypes, fn: ListenerFn, context?: any): this

  • Add a listener for a given event.

    Parameters

    • event: EventTypes
    • fn: ListenerFn
    • Optional context: any

    Returns this

once

  • once(event: EventTypes, fn: ListenerFn, context?: any): this

  • Add a one-time listener for a given event.

    Parameters

    • event: EventTypes
    • fn: ListenerFn
    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventTypes): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: EventTypes

    Returns this

removeListener

  • removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: boolean): this

  • Remove the listeners of a given event.

    Parameters

    • event: EventTypes
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns this

Generated using TypeDoc