Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dispatcher

Hierarchy

  • Dispatcher

Index

Constructors

constructor

  • Returns Dispatcher

Properties

Protected log

log: Log

Methods

addListener

  • addListener(event: string, listener: Listener): this
  • Parameters

    • event: string
    • listener: Listener

    Returns this

dispatch

  • dispatch(name: any, ...args: any[]): Promise<boolean>
  • Parameters

    • name: any
    • Rest ...args: any[]

    Returns Promise<boolean>

emit

  • emit(event: string | string[], ...values: any[]): boolean
  • Parameters

    • event: string | string[]
    • Rest ...values: any[]

    Returns boolean

emitAsync

  • emitAsync(event: string | string[], ...values: any[]): Promise<any[]>
  • Parameters

    • event: string | string[]
    • Rest ...values: any[]

    Returns Promise<any[]>

enableDebug

  • enableDebug(): void
  • Returns void

eventNames

  • eventNames(): string[]
  • Returns string[]

fire

  • fire<T>(ctx: T): T
  • fire<T>(event: string | string[], ctx: T): T
  • Type parameters

    Parameters

    • ctx: T

    Returns T

  • Type parameters

    Parameters

    • event: string | string[]
    • ctx: T

    Returns T

halt

  • halt<T>(event: string | string[], ctx: T): void
  • Type parameters

    Parameters

    • event: string | string[]
    • ctx: T

    Returns void

many

  • many(event: string | string[], timesToListen: number, listener: Listener): this
  • Parameters

    • event: string | string[]
    • timesToListen: number
    • listener: Listener

    Returns this

off

  • off(event: string, listener: Listener): this
  • Parameters

    • event: string
    • listener: Listener

    Returns this

offAny

  • offAny(listener: Listener): this
  • Parameters

    • listener: Listener

    Returns this

on

  • on(event: string | string[], listener: Listener): this
  • Parameters

    • event: string | string[]
    • listener: Listener

    Returns this

onAny

  • onAny(listener: EventAndListener): this
  • Parameters

    • listener: EventAndListener

    Returns this

once

  • once(event: string | string[], listener: Listener): this
  • Parameters

    • event: string | string[]
    • listener: Listener

    Returns this

prependAny

  • prependAny(listener: EventAndListener): this
  • Parameters

    • listener: EventAndListener

    Returns this

prependListener

  • prependListener(event: string | string[], listener: Listener): this
  • Parameters

    • event: string | string[]
    • listener: Listener

    Returns this

prependMany

  • prependMany(event: string | string[], timesToListen: number, listener: Listener): this
  • Parameters

    • event: string | string[]
    • timesToListen: number
    • listener: Listener

    Returns this

prependOnceListener

  • prependOnceListener(event: string | string[], listener: Listener): this
  • Parameters

    • event: string | string[]
    • listener: Listener

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | eventNS): this
  • Parameters

    • Optional event: string | eventNS

    Returns this

removeListener

  • removeListener(event: string | string[], listener: Listener): this
  • Parameters

    • event: string | string[]
    • listener: Listener

    Returns this

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

Generated using TypeDoc