Options
All
  • Public
  • Public/Protected
  • All
Menu

A class that provides a custom event channel.

You may bind a callback to an event with on or remove with off; trigger-ing an event fires all callbacks in succession.

Hierarchy

Index

Constructors

constructor

Methods

listenTo

listenToOnce

off

on

once

  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    Returns EventDispatcher

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns EventDispatcher

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns EventDispatcher

Generated using TypeDoc