Class Relays

Extended EventEmitter that also emits all events to '*' listeners

Hierarchy (View Summary)

Constructors

constructor

Properties

connections defaultMaxListeners

Methods

addListener cleanup emit eventNames getMaxListeners listenerCount listeners off on once onMessage prependListener prependOnceListener rawListeners removeAllListeners removeListener send setMaxListeners listenerCount

Constructors

constructor

Properties

Readonlyconnections

connections: Connection[]

StaticdefaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

cleanup

  • cleanup(): void

  • Returns void

emit

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

  • Emits an event to listeners and to '*' listeners

    Parameters

    • type: string

      Event type/name

    • ...args: any[]

      Arguments to pass to listeners

    Returns boolean

    True if event had listeners

eventNames

  • eventNames(): (string | number)[]

  • Returns (string | number)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | number): number

  • Parameters

    • type: string | number

    Returns number

listeners

  • listeners(type: string | number): Listener[]

  • Parameters

    • type: string | number

    Returns Listener[]

off

  • off(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

on

  • on(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

once

  • once(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

onMessage

  • onMessage(connection: Connection, __namedParameters: Message): void

  • Parameters

    Returns void

prependListener

  • prependListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

prependOnceListener

  • prependOnceListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

rawListeners

  • rawListeners(type: string | number): Listener[]

  • Parameters

    • type: string | number

    Returns Listener[]

removeAllListeners

  • removeAllListeners(type?: string | number): this

  • Parameters

    • Optionaltype: string | number

    Returns this

removeListener

  • removeListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

send

  • send(...payload: Message): Promise<void>

  • Parameters

    Returns Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

StaticlistenerCount

  • listenerCount(emitter: EventEmitter, type: string | number): number

  • Parameters

    • emitter: EventEmitter
    • type: string | number

    Returns number

Settings

Member Visibility

On This Page

Constructors
Properties
Methods