Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventEmitter

An object which represents an event queue.

Similar to NodeJS event emitter.

Hierarchy

  • EventEmitter

Index

Properties

Methods

Properties

eventQueue

eventQueue: EmitterEvent[]

Methods

emit

  • emit(evtName: String, ...args: any): void

  • Fires an event.

    Parameters

    • evtName: String

      The event name to fire.

    • Rest ...args: any

      The arguments to pass.

    Returns void

on

  • on(evtName: String, callback: Function): void

  • Listens for an event.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

once

  • once(evtName: String, callback: Function): void

  • Listens for an event once.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

Generated using TypeDoc