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

  • EventDispatcher

Index

Constructors

constructor

Properties

Private Optional _events

_events: EventHandlers

Map of all handlers registered with the "on" function.

Private Optional _listeners

_listeners: EventListeners

Map of all objects that are listening to this instance.

Private Optional _listeningTo

_listeningTo: EventListeners

Map of all objects this instance is listening to.

Private Optional _savedListenId

_savedListenId: string

Accessors

Private _listenId

  • get _listenId(): string

Methods

Private internalOn

  • internalOn(name: string | EventMap, callback: undefined | EventCallback, context?: any, priority?: number, listening?: EventListener): void
  • Guard the listening argument from the public API.

    Parameters

    • name: string | EventMap
    • callback: undefined | EventCallback
    • Optional context: any
    • priority: number = 0
    • Optional listening: EventListener

    Returns void

listenTo

  • Inversion-of-control versions of on. Tell this object to listen to an event in another object... keeping track of what it's listening to for easier unbinding later.

    Parameters

    • obj: EventDispatcher
    • name: string | EventMap
    • Optional callback: EventCallback
    • Optional priority: number

    Returns EventDispatcher

listenToOnce

off

on

  • on(eventMap: EventMap, context?: any): EventDispatcher
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): EventDispatcher
  • on(name: string, callback: EventCallback, context?: any, priority?: number): EventDispatcher

once

  • once(eventMap: EventMap, context?: any): EventDispatcher
  • once(name: string, callback: EventCallback, context?: any, priority?: any): EventDispatcher
  • 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

    • eventMap: EventMap
    • Optional context: any

    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

    • name: string | Event | EventMap
    • Rest ...args: any[]

    Returns EventDispatcher

Generated using TypeDoc