Document Q.any and credit @vergara.

kriskowal · Feb 22, 2015 · 0db9a02 · 0db9a02
1 parent 408e69c
commit 0db9a02
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,7 +2,7 @@
 
 ## 1.2.0
 
- - Added Q.any(promisesArray) method.
+ - Added Q.any(promisesArray) method (@vergara).
    Returns a promise fulfilled with the value of the first resolved promise in
    promisesArray. If all promises in promisesArray are rejected, it returns
    a rejected promise.

diff --git a/README.md b/README.md
@@ -335,6 +335,18 @@ Q.allSettled(promises)
 });
 ```
 
+The ``any`` function accepts an array of promises and returns a promise that is
+fulfilled by the first given promise to be fulfilled, or rejected if all of the
+given promises are rejected.
+
+```javascript
+Q.any(promises)
+.then(function (first) {
+    // Any of the promises was fulfilled.
+}, function (error) {
+    // All of the promises were rejected.
+});
+```
 
 ### Sequences