Members

allSettled ⇒ Promise

The Promise.allSettled() method returns a promise that resolves after all of the given promises have either resolved or rejected, with an array of objects that each describe the outcome of each promise.

nfcall ⇒ Promise

Calls a Node.js-style function with the given variadic arguments, returning a promise that is fulfilled if the Node.js function calls back with a result, or rejected if it calls back with an error (or throws one synchronously).

Objects

Promise : object

Native Promise

Deferred : object

A deferred to many promise

Functions

parse(promise) ⇒ Promise

Transform a promise to a native Promise instance

defer() ⇒ Deferred

Create a new deferred

isPromiseLike(promise) ⇒ boolean

Check if any value has a .then function

allSettled ⇒ Promise

The Promise.allSettled() method returns a promise that resolves after all of the given promises have either resolved or rejected, with an array of objects that each describe the outcome of each promise.

Kind: global variable

Param	Type
promises	Array

Example

var d1 = $q.defer();
var d2 = $q.defer();
$q.allSettled([
     d1.promise,
     d2.promise
])
     .then((results) => {
         // results contain [{status: 'fulfilled', value: 'test'}, {status: 'rejected', reason: 'test2'}]
     });
d1.resolve('test'); // Not resolved
d2.reject('test2'); // Resolved

nfcall ⇒ Promise

Calls a Node.js-style function with the given variadic arguments, returning a promise that is fulfilled if the Node.js function calls back with a result, or rejected if it calls back with an error (or throws one synchronously).

Kind: global variable

Param	Type
command	function
...args	any

Example

$q.nfcall(FS.readFile, "foo.txt", "utf-8").done(function (text) {
});

Promise : object

Native Promise

Kind: global namespace

• Promise : object
  • .fail(onReject) ⇒ Promise
  • .finally(onFinally) ⇒ Promise
  • .spread(onFulfilled, onRejected) ⇒ Promise

promise.fail(onReject) ⇒ Promise

Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.

Kind: instance method of Promise
Returns: Promise - Internally calls Promise.prototype.then on the object upon which it was called, passing the parameters undefined and the received onRejected handler. Returns the value of that call, which is a Promise.

Param	Type	Description
onReject	function	A Function called when the Promise is rejected. This function has one argument: reason The rejection reason.

promise.finally(onFinally) ⇒ Promise

Appends a handler to the promise, and returns a new promise which is resolved when the original promise is resolved. The handler is called when the promise is settled, whether fulfilled or rejected.

Kind: instance method of Promise
Returns: Promise - Returns a Promise whose finally handler is set to the specified function, onFinally.

Param	Type	Description
onFinally	function	A Function called when the Promise is settled.

promise.spread(onFulfilled, onRejected) ⇒ Promise

Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason.

Kind: instance method of Promise

Param	Type
onFulfilled	function
onRejected	function

Deferred : object

A deferred to many promise

Kind: global namespace

• Deferred : object
  • promise : Promise
  • instance
    • .resolve(value)
    • .reject(reason)

Deferredpromise : Promise

Linked promise

deferred.resolve(value)

Resolve a promise

Kind: instance method of Deferred

Param	Type
value	*

deferred.reject(reason)

Reject a promise

Kind: instance method of Deferred

Param	Type
reason	*

parse(promise) ⇒ Promise

Transform a promise to a native Promise instance

Kind: global function

Param	Type	Description
promise	any	If a promise is provided, it transformed to a native Promise, if any other type is provided, the returned promise will be resolved.

defer() ⇒ Deferred

Create a new deferred

Kind: global function

isPromiseLike(promise) ⇒ boolean

Check if any value has a .then function

Kind: global function

Param	Type
promise	any

Example

$q.isPromiseLike(true); // false

$q.isPromiseLike({
 then: function () {}
}); // true

$q.isPromiseLike($q.resolve()); // true