Merge pull request #9 from AmrSaber/dev

Update description and return type

package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-short-circuit",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Short circuit logic for boolean promises",
   "main": "src/index.js",
   "types": "src/index.d.ts",

src/index.d.ts

@@ -10,7 +10,7 @@
  *
  * @returns a promise that resolves with the result of ANDing the given promises.
  */
-export function asyncAnd(promises: Promise[]): Promise;
+export function asyncAnd(promises: Promise[]): Promise<any>;
 
 
 /**
@@ -25,4 +25,4 @@ export function asyncAnd(promises: Promise[]): Promise;
  *
  * @returns a promise that resolves with the result of ORing the given promises.
  */
-export function asyncOr(promises: Promise[]): Promise;
+export function asyncOr(promises: Promise[]): Promise<any>;

src/index.js

@@ -1,15 +1,3 @@
-/**
- * Performs logical AND among the given promises with short-circuit logic.
- * Returns the result of ANDing the results of all the given promises,
- * but stops as soon as the first false value is resolved and returns that value.
- *
- * Note that this considers the resolve time precedence and not the promises order,
- * unless all the promises resolve to true, then it will consider the order to perform the AND manually.
- *
- * @param {[Promise]} promises
- *
- * @returns {Promise<Any>}
- */
 function asyncAnd(promises) {
   return new Promise((resolve, reject) => {
     const notify = value => { if (!value) { resolve(value); } else { return value; } };
@@ -23,18 +11,6 @@ function asyncAnd(promises) {
   });
 }
 
-/**
- * Performs logical OR among the given promises with short-circuit logic.
- * Returns the result of ORing the results of all the given promises,
- * but stops as soon as the first truthy value is resolved and returns that value.
- *
- * Note that this considers the resolve time precedence and not the promises order,
- * unless all the promises resolve to false, then it will consider the order to perform the OR manually.
- *
- * @param {[Promise]} promises
- *
- * @returns {Promise<Any>}
- */
 function asyncOr(promises) {
   return new Promise((resolve, reject) => {
     const notify = value => { if (value) { resolve(value); } else { return value; } };