Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEventEmitter<T>

Entity that raises events that can be subscribed to

typeparam

type

Type parameters

  • T: string

Hierarchy

Index

Methods

Methods

off

  • off(eventType: T, handler?: EventHandler, once?: boolean): void
  • Unregisters an event handler

    Parameters

    • eventType: T

      Event to unregister from

    • Optional handler: EventHandler

      Event handler function. If not passed in, it removes all event handlers.

    • Optional once: boolean

      Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

    Returns void

on

  • Registers an event handler

    Parameters

    • eventType: T

      Event to listen for

    • handler: EventHandler

      Event handler function

    Returns void

once

  • Registers an event handler that is only run once

    Parameters

    • eventType: T

      Event to listen for

    • handler: EventHandler

      Event handler function

    Returns void