notes

mirror of https://github.com/thangisme/notes.git synced 2024-12-22 12:16:30 -05:00

History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
index.js	Initial commit	2017-03-09 13:16:08 -05:00
license	Initial commit	2017-03-09 13:16:08 -05:00
package.json	Initial commit	2017-03-09 13:16:08 -05:00
readme.md	Initial commit	2017-03-09 13:16:08 -05:00

readme.md

Itty bitty little widdle twinkie pinkie ES2015 Promise implementation

There are tons of Promise implementations out there, but all of them focus on browser compatibility and are often bloated with functionality.

This module is an exact Promise specification polyfill (like native-promise-only), but in Node.js land (it should be browserify-able though).

Install

$ npm install --save pinkie

Usage

var fs = require('fs');
var Promise = require('pinkie');

new Promise(function (resolve, reject) {
	fs.readFile('foo.json', 'utf8', function (err, data) {
		if (err) {
			reject(err);
			return;
		}

		resolve(data);
	});
});
//=> Promise

API

pinkie exports bare ES2015 Promise implementation and polyfills Node.js rejection events. In case you forgot:

new Promise(executor)

Returns new instance of Promise.

executor

Required
Type: function

Function with two arguments resolve and reject. The first argument fulfills the promise, the second argument rejects it.

pinkie.all(promises)

Returns a promise that resolves when all of the promises in the promises Array argument have resolved.

pinkie.race(promises)

Returns a promise that resolves or rejects as soon as one of the promises in the promises Array resolves or rejects, with the value or reason from that promise.

pinkie.reject(reason)

Returns a Promise object that is rejected with the given reason.

pinkie.resolve(value)

Returns a Promise object that is resolved with the given value. If the value is a thenable (i.e. has a then method), the returned promise will "follow" that thenable, adopting its eventual state; otherwise the returned promise will be fulfilled with the value.

pinkie-promise - Returns the native Promise or this module