Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Emitter

abstract
author

SolalDR - solal.dussout-revel@hotmail.fr

Hierarchy

  • Emitter

Index

Constructors

Methods

Constructors

constructor

  • Returns Emitter

Methods

emit

  • emit(event: string | string[], args: unknown): Emitter

  • Trigger the call-backs registered for an event

    Parameters

    • event: string | string[]
    • args: unknown

      An object passed in argument of the callback

    Returns Emitter

    Return "this"

listenerExist

  • listenerExist(event: string, callback: EmitterCallback): boolean

  • Test if a function is registered in the _listeners' stack

    Parameters

    • event: string
    • callback: EmitterCallback

    Returns boolean

    boolean

off

  • off(event: string, callback: EmitterCallback): Emitter

  • Unregister a callback from an event

    Parameters

    • event: string
    • callback: EmitterCallback

    Returns Emitter

    Return "this"

on

  • on(event: string | string[], callback: EmitterCallback): Emitter

  • Register a new call-back for an event

    Parameters

    • event: string | string[]
    • callback: EmitterCallback

    Returns Emitter

    Return "this"

once

  • once(event: string, callback: EmitterCallback): Emitter

  • Register a call-back for an event that will be triggered once.

    Parameters

    • event: string
    • callback: EmitterCallback

    Returns Emitter

onceAll

  • onceAll(events: string[], callback: EmitterCallback): Emitter

  • Register a call-back for a list of event that will be triggered once all the _listeners will be triggered.

    Parameters

    • events: string[]
    • callback: EmitterCallback

    Returns Emitter

    Return "this"

Generated using TypeDoc