Skip to content
This repository was archived by the owner on Nov 15, 2018. It is now read-only.

Commit 5926911

Browse files
committed
Update README with additional API documentation
Added docs for Promise.all and Promise.race. Bumped package.json version number in anticipation of next release.
1 parent 1af76d2 commit 5926911

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# [![Promises/A+](https://promisesaplus.com/assets/logo-small.png)](https://promisesaplus.com) Fidelity
22

33
[![Coverage Status](https://coveralls.io/repos/github/bucharest-gold/fidelity/badge.svg?branch=master)](https://coveralls.io/github/bucharest-gold/fidelity?branch=master)
4-
[![Build Status](https://travis-ci.org/bucharest-gold/fidelity.svg?branch=master)](https://travis-ci.org/bucharest-gold/fidelity)
5-
[![Known Vulnerabilities](https://snyk.io/test/npm/fidelity/badge.svg)](https://snyk.io/test/npm/fidelity)
4+
[![Build Status](https://travis-ci.org/bucharest-gold/fidelity.svg?branch=master)](https://travis-ci.org/bucharest-gold/fidelity)
5+
[![Known Vulnerabilities](https://snyk.io/test/npm/fidelity/badge.svg)](https://snyk.io/test/npm/fidelity)
66
[![dependencies Status](https://david-dm.org/bucharest-gold/fidelity/status.svg)](https://david-dm.org/bucharest-gold/fidelity)
77

88
[![NPM](https://nodei.co/npm/fidelity.png)](https://npmjs.org/package/fidelity)
@@ -111,6 +111,24 @@ with the provided `value`.
111111
A static utility function that returns a promise which has been rejected
112112
with the provided `reason`.
113113

114+
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject
115+
116+
### Fidelity.all(iterable)
117+
118+
A static utility function which returns a promise that resolves when all
119+
of the promises in the iterable argument have resolved, or rejects with
120+
the reason of the first passed promise that rejects.
121+
122+
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/all
123+
124+
### Fidelity.race(iterable)
125+
126+
A static utility function which returns a promise that resolves or rejects as
127+
soon as one of the promises in the iterable resolves or rejects, with the value
128+
or reason from that promise.
129+
130+
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race
131+
114132
### Fidelity.deferred()
115133

116134
A static utility function that Creates and returns a `deferred` object.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "fidelity",
3-
"version": "4.0.0",
3+
"version": "4.1.0",
44
"description": "A simple and fast Promises/A+ implementation",
55
"engines" : { "node" : ">=4.0" },
66
"main": "lib/index.js",

0 commit comments

Comments
 (0)