API Docs for: 3.11.0-git
Show:

Promise.EventNotifier Class

Defined in: src/sm-promise-events/js/events.js:15
Module: gallery-sm-promise-events

Constructor

Promise.EventNotifier

()

Defined in src/sm-promise-events/js/events.js:15

Item Index

Methods

Methods

addEvents

(
  • promise
)
Promise

Defined in src/sm-promise-events/js/events.js:68

Decorate a promise and register it and its kin as targets for notifications from this instance.

Returns the input promise.

Parameters:

  • promise Promise

    The Promise to add event support to

Returns:

Promise:

decorate

(
  • promise
)
static

Defined in src/sm-promise-events/js/events.js:24

Decorate a Promise with an on method and make its then method propagate event support to its generated child promises.

Parameters:

  • promise Promise

    the Promise to add event support to

fire

(
  • type
  • [args*]
)
Promise.EventNotifier chainable

Defined in src/sm-promise-events/js/events.js:84

Notify registered Promises and their children of an event. Subscription callbacks will be passed additional args parameters.

Parameters:

  • type String

    The name of the event to notify subscribers of

  • [args*] Any optional

    Arguments to pass to the callbacks

Returns:

Promise.EventNotifier:

this instance