floatdrop/pinkie


Itty bitty little widdle twinkie pinkie ES2015 Promise implementation

License: MIT

Language: JavaScript



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

Project Statistics

Sourcerank 15
Repository Size 693 KB
Stars 127
Forks 16
Watchers 5
Open issues 1
Dependencies 6
Contributors 4
Tags 8
Created
Last updated
Last pushed

Top Contributors See all

Vsevolod Strukchinsky Sindre Sorhus James Talmage Vadim Demedes

Packages Referencing this Repo

pinkie
Itty bitty little widdle twinkie pinkie ES2015 Promise implementation
Latest release 2.0.5 - Updated - 127 stars
org.webjars.npm:pinkie
WebJar for pinkie
Latest release 2.0.4 - Updated - 127 stars

Recent Tags See all

v2.0.4 February 01, 2016
v2.0.3 February 01, 2016
v2.0.2 January 31, 2016
v2.0.1 November 17, 2015
v2.0.0 November 12, 2015
v1.0.0 May 11, 2015
v0.0.2 May 11, 2015
v0.0.1 May 10, 2015

Something wrong with this page? Make a suggestion

Last synced: 2018-01-06 19:19:45 UTC

Login to resync this repository