Skip to content
Itty bitty little widdle twinkie pinkie ES2015 Promise implementation
Branch: master
Clone or download
Latest commit 8d4a924 Feb 1, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
media
.editorconfig
.gitattributes Initial version from es6-promise-polyfill May 10, 2015
.gitignore add coverage report Nov 9, 2015
.travis.yml add coverage report Nov 9, 2015
appveyor.yml add appveyor.yml and badge Nov 17, 2015
index.js Fix #14 Feb 1, 2016
license
package.json
readme.md
test.js

readme.md


pinkie

Itty bitty little widdle twinkie pinkie ES2015 Promise implementation

Build Status Coverage Status

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.

Related

License

MIT © Vsevolod Strukchinsky

You can’t perform that action at this time.