bluebird-api

Introduction

Bluebird compatible API on top of native promises as a drop-in replacement.

WIP - contributions welcome.

Getting started

bluebird-api depends on node 7.0 and above

$ npm install bluebird-api

Then :

const Promise = require('bluebird-api');

Contributing

Fork the repository
git clone https://github.com/**your GH user**/bluebird-api
cd bluebird-api
npm install
npm test

Before committing changes run npm run build

Commit build along with your changes to the repo.

Why

There are many reasons to use bluebird. As native Promise implementations improve, bluebird-api allows keeping the same code but enjoying the benefits of improved native Promises.

API

http://bluebirdjs.com/docs/api-reference.html

Core

Promise.then

.then(
    [function(any value) fulfilledHandler],
    [function(any error) rejectedHandler]
) -> Promise

.catch is a convenience method for handling errors in promise chains. It comes in two variants - A catch-all variant similar to the synchronous catch(e) { block. This variant is compatible with native promises. - A filtered variant (like other non-JS languages typically have) that lets you only handle specific errors. This variant is usually preferable and is significantly safer.

Promise.error

.error([function(any error) rejectedHandler]) -> Promise

Like .catch but instead of catching all types of exceptions, it only catches operational errors.

Note, "errors" mean errors, as in objects that are instanceof Error - not strings, numbers and so on.

Promise.spread

Like calling .then, but the fulfillment value must be an array, which is flattened to the formal parameters of the fulfillment handler.

.spread([function(any values...) fulfilledHandler]) -> Promise

Promise.finally

.finally(function() handler) -> Promise

.lastly(function() handler) -> Promise

Pass a handler that will be called regardless of this promise's fate. Returns a new promise chained from this promise. There are special semantics for .finally in that the final value cannot be modified from the handler.

Note: using .finally for resource management has better alternatives, see resource management

Promise.join

For coordinating multiple concurrent discrete promises. While .all is good for handling a dynamically sized list of uniform promises, Promise.join is much easier (and more performant) to use when you have a fixed amount of discrete promises that you want to coordinate concurrently. The final parameter, handler function, will be invoked with the result values of all of the fufilled promises.

Promise.join(Promise<any>|any values..., function handler) -> Promise

Promise.try

Start the chain of promises with Promise.try. Any synchronous exceptions will be turned into rejections on the returned promise.

Promise.try(function() fn) -> Promise

Promise.method

Returns a new function that wraps the given function fn. The new function will always return a promise that is fulfilled with the original functions return values or rejected with thrown exceptions from the original function.

Promise.method(function(...arguments) fn) -> function

Promise.suppressUnhandledRejections

.suppressUnhandledRejections() -> undefined

Basically sugar for doing:

somePromise.catch(function(){});

Which is needed in case error handlers are attached asynchronously to the promise later, which would otherwise result in premature unhandled rejection reporting.

Promise.onPossiblyUnhandledRejection

Promise.onPossiblyUnhandledRejection(function(any error, Promise promise) handler) -> undefined

Note: this hook is specific to the bluebird instance its called on, application developers should use global rejection events

Add handler as the handler to call when there is a possibly unhandled rejection. The default handler logs the error stack to stderr or console.error in browsers.

Promise.onPossiblyUnhandledRejection(function(e, promise) {
    throw e;
});

Passing no value or a non-function will have the effect of removing any kind of handling for possibly unhandled rejections.

Timers

.delay

Returns a promise that will be resolved with ms milliseconds.

.delay(int ms) -> Promise

.timeout

Returns a promise that will be fulfilled with this promise's fulfillment value or rejection reason. However, if this promise is not fulfilled or rejected within ms milliseconds, the returned promise is rejected with a TimeoutError or the error as the reason.

.timeout(int ms, [String message="operation timed out"]) -> Promise
---
.timeout(int ms, [Error error]) -> Promise

Promisification

Promise.promisify

Returns a function that will wrap the given nodeFunction. Instead of taking a callback, the returned function will return a promise whose fate is decided by the callback behavior of the given node function. The node function should conform to node.js convention of accepting a callback as last argument and calling that callback with error as the first argument and success value on the second argument.

Promise.promisify(
  function(any arguments..., function callback) nodeFunction,
  [Object { multiArgs: boolean=false, context: any=this } options]
) -> function

Promise.asCallback

.asCallback(
    [function(any error, any value) callback],
    [Object {spread: boolean=false} options]
) -> this

.nodeify(
    [function(any error, any value) callback],
    [Object {spread: boolean=false} options]
) -> this

Register a node-style callback on this promise. When this promise is either fulfilled or rejected, the node callback will be called back with the node.js convention where error reason is the first argument and success value is the second argument. The error argument will be null in case of success.

Returns back this promise instead of creating a new one. If the callback argument is not a function, this method does not do anything.

Collections

.props

Like .all but for object properties or Maps entries instead of iterated values. Returns a promise that is fulfilled when all the properties of the object or the Map's values are fulfilled. The promise's fulfillment value is an object or a Map with fulfillment values at respective keys to the original object or a Map. If any promise in the object or Map rejects, the returned promise is rejected with the rejection reason.

.props(Object|Map|Promise<Object|Map> input) -> Promise

.each

Iterate over an array, or a promise of an array, which contains promises (or a mix of promises and values) with the given iterator function with the signature (value, index, length) where value is the resolved value of a respective promise in the input array. Iteration happens serially. If any promise in the input array is rejected the returned promise is rejected as well.

.each(function(any item, int index, int length) iterator) -> Promise

.mapSeries

.mapSeries(function(any item, int index, int length) mapper) -> Promise

.map

.map(function(any item, int index, int length) mapper, [Object {concurrency: int=Infinity} options]) -> Promise

.filter

.filter(function(any item, int index, int length) filterer, [Object {concurrency: int=Infinity} options]) -> Promise

.reduce

Promise.reduce(
    Iterable<any>|Promise<Iterable<any>> input,
    function(any accumulator, any item, int index, int length) reducer,
    [any initialValue]
) -> Promise

Given an Iterable(arrays are Iterable), or a promise of an Iterable, which produces promises (or a mix of promises and values), iterate over all the values in the Iterable into an array and [reduce the array to a value](https://en.wikipedia.org/wiki/Fold_(higher-order_function) using the given reducer function.

If the reducer function returns a promise, then the result of the promise is awaited, before continuing with next iteration. If any promise in the array is rejected or a promise returned by the reducer function is rejected, the result is rejected as well.

.some

Promise.some(
    Iterable<any>|Promise<Iterable<any>> input,
    int count
) -> Promise

Given an Iterable(arrays are Iterable), or a promise of an Iterable, which produces promises (or a mix of promises and values), iterate over all the values in the Iterable into an array and return a promise that is fulfilled as soon as count promises are fulfilled in the array. The fulfillment value is an array with count values in the order they were fulfilled.

.any

Promise.any(Iterable<any>|Promise<Iterable<any>> input) -> Promise

Like Promise.some, with 1 as count. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.

Utility

.tap

Accept a resolved value (is not called for rejections) and passes value through to the next handler.

.tap(function(any value) handler) -> Promise

.get

Convenience method for getting a property of a resolved object.

.get(String propertyName|int index) -> Promise

.call

Convenience method for calling a method of a resolved object.

.call(String methodName, [any args...])

.reflect

The .reflect method returns a promise that is always successful when this promise is settled. Its fulfillment value is an object that implements the PromiseInspection interface and reflects the resolution of this promise.

.reflect() -> Promise<PromiseInspection>

.noConflict

Promise.noConflict() -> Object

This is relevant to browser environments with no module loader.

Release control of the Promise namespace to whatever it was before this library was loaded. Returns a reference to the library namespace so you can attach it to something else.

The .reflect method returns a promise that is always successful when this promise is settled. Its fulfillment value is an object that implements the PromiseInspection interface and reflects the resolution of this promise.

.return

.return(any value) -> Promise
.thenReturn(any value) -> Promise

Convenience method for:

.then(function() {
   return value;
});

in the case where value doesn't change its value because its binding time is different than when using a closure.

.throw

.throw(any reason) -> Promise
.thenThrow(any reason) -> Promise

Convenience method for:

.then(function() {
   throw reason;
});

Same limitations regarding to the binding time of reason to apply as with .return.

For compatibility with earlier ECMAScript version, an alias .thenThrow is provided for .throw.

.catchReturn

.catchReturn(
    [class ErrorClass|function(any error) predicate],
    any value
) -> Promise

Convenience method for:

.catch(function() {
   return value;
});

You may optionally prepend one predicate function or ErrorClass to pattern match the error (the generic .catch methods accepts multiple)

Same limitations regarding to the binding time of value to apply as with .return.

.catchThrow

.catchThrow(
    [class ErrorClass|function(any error) predicate],
    any reason
) -> Promise

Convenience method for:

.catch(function() {
   throw reason;
});

You may optionally prepend one predicate function or ErrorClass to pattern match the error (the generic .catch methods accepts multiple)

Same limitations regarding to the binding time of reason to apply as with .return.

.tapCatch

tapCatch is a convenience method for reacting to errors without handling them with promises - similar to finally but only called on rejections. Useful for logging errors.

Generators

.coroutine

Promise.coroutine(GeneratorFunction(...arguments) generatorFunction, Object options) -> function

Returns a function that can use yield to yield promises. Control is returned back to the generator when the yielded promise settles. This can lead to less verbose code when doing lots of sequential async calls with minimal processing in between. Requires node.js 0.12+, io.js 1.0+ or Google Chrome 40+.

Deprecated

.cast

This API is deprecated both in bluebird and bluebird-api, and exist in bluebird-api as part of backward compatibility.

.defer

Deferreds are deprecated in favor of the promise constructor. If you need deferreds for some reason, you can create them trivially using the constructor:

function defer() {
    var resolve, reject;
    var promise = new Promise(function() {
        resolve = arguments[0];
        reject = arguments[1];
    });
    return {
        resolve: resolve,
        reject: reject,
        promise: promise
    };
}

Configuration

.done

.done(
    [function(any value) fulfilledHandler],
    [function(any error) rejectedHandler]
) -> undefined

Like .then, but any unhandled rejection that ends up here will crash the process (in node) or be thrown as an error (in browsers). The use of this method is heavily discouraged and it only exists for historical reasons.

Resouce Management

.using

Promise.using(
    Promise|Disposer|any resource,
    Promise|Disposer|any resource...,
    function(any resources...) handler
) -> Promise

Promise.using(
    Array<Promise|Disposer|Any> resources,
    function(Array<any> resources) handler
) -> Promise

In conjunction with .disposer, using will make sure that no matter what, the specified disposer will be called when the promise returned by the callback passed to using has settled. The disposer is necessary because there is no standard interface in node for disposing resources.

.disposer

.disposer(function(any resource, Promise usingOutcomePromise) disposer) -> Disposer

A meta method used to specify the disposer method that cleans up a resource when using Promise.using.

Returns a Disposer object which encapsulates both the resource as well as the method to clean it up. The user can pass this object to Promise.using to get access to the resource when it becomes available, as well as to ensure it's automatically cleaned up.

The second argument passed to a disposer is the result promise of the using block, which you can inspect synchronously.

License

Some tests under MIT license for Kris Kowal, Petka Antonov and Brian Cavalier

benjamingr/bluebird-api

bluebird-api

Introduction

Getting started

Contributing

Why

API

Core

Timers

Promisification

Collections

Utility

Convenience method for:

Convenience method for:

Convenience method for:

Convenience method for:

Generators

Deprecated

.cast

Configuration

Resouce Management

License