Merge pull request #59 from Sykander/develop

Release 1.0.3

Author: Sykander

README.md

@@ -27,22 +27,23 @@ class AsyncArray extends Array {...}
 * Async Find Index
 * Async For Each
 * Async Map
+* Async Sort
 
-### Async Filter 
+### [Async Filter](https://github.com/Sykander/iterable-async/wiki/Async-Filter) 
 
 Filter an iterable object asynchronously
 ```
 async function asyncFilter(callback, [thisArg]) {...}
 ```
 
-### Async Find
+### [Async Find](https://github.com/Sykander/iterable-async/wiki/Async-Find)
 
 Find an item in an iterable object asynchronously
 ```
 async function asyncFind(callback, [thisArg]) {...}
 ```
 
-### Async Find Index
+### [Async Find Index](https://github.com/Sykander/iterable-async/wiki/Async-Find-Index)
 
 Find an item's index in an iterable object asynchronously
 ```
@@ -56,13 +57,19 @@ Loop over an iterable object asynchronously
 async function asyncForEach(callback, [thisArg]) {...}
 ```
 
-### Async Map
+### [Async Map](https://github.com/Sykander/iterable-async/wiki/Async-Map)
 
 Map an iterable object asynchronously
 ```
 async function asyncMap(callback, [thisArg]) {...}
 ```
 
+### [Async Sort](https://github.com/Sykander/iterable-async/wiki/Async-Sort) 
+
+Sort an iterable object asynchronously
+```
+async function asyncSort(callback) {...}
+```
 
 ## Development
 
@@ -86,4 +93,4 @@ npm test
 
 ### Commit Rules
 
-* All commits should pass the lint check commands
+* All commits should pass the lint check commands

docs/playground.js

@@ -4,5 +4,6 @@ const {
 	asyncFindIndex,
 	asyncFilter,
 	asyncForEach,
-	asyncMap
+	asyncMap,
+	asyncSort
 } = require('iterable-async');

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "iterable-async",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A Collection of useful patterns.",
   "main": "src",
   "scripts": {
@@ -35,5 +35,12 @@
       "pre-commit": "npm run lint:check"
     }
   },
+  "keywords": [
+    "promise",
+    "iterable",
+    "async",
+    "array",
+    "methods"
+  ],
   "runkitExampleFilename": "docs/playground.js"
 }

package.json

@@ -2,10 +2,13 @@ const asyncMap = require('./async-map'),
 	asyncForEach = require('./async-for-each'),
 	asyncFilter = require('./async-filter'),
 	asyncFind = require('./async-find'),
-	asyncFindIndex = require('./async-find-index');
+	asyncFindIndex = require('./async-find-index'),
+	asyncSort = require('./async-sort');
 
 /**
- * Create new constructor for Async Array
+ * Async Array
+ * ===========
+ * Array like object with access to async array methods
  * @type {AsyncArray}
  */
 class AsyncArray extends Array {}
@@ -15,6 +18,7 @@ class AsyncArray extends Array {}
 	(AsyncArray.prototype.asyncFindIndex = asyncFindIndex),
 	(AsyncArray.prototype.asyncFilter = asyncFilter),
 	(AsyncArray.prototype.asyncForEach = asyncForEach),
-	(AsyncArray.prototype.asyncMap = asyncMap);
+	(AsyncArray.prototype.asyncMap = asyncMap),
+	(AsyncArray.prototype.asyncSort = asyncSort);
 
 module.exports = AsyncArray;

src/async-array.js

@@ -1,9 +1,10 @@
-const { mapIterable } = require('./helpers'),
+const { mapIterable, filterIterable } = require('./helpers'),
 	{ noParam } = require('./constants'),
 	{ validateIsIterable, validateIsFunction } = require('./validation');
 
 /**
  * Async Filter
+ * ============
  * Filter an iterable object asynchronously and resolve when all callbacks are resolved
  * @async
  * @param {Function} callback - callback(currentValue, index, array)
@@ -17,7 +18,8 @@ module.exports = async function asyncFilter(callback, thisArg = noParam) {
 	validateIsFunction(callback);
 	validateIsIterable(collection);
 
-	const checks = await Promise.all(mapIterable(collection, callback));
-
-	return [...collection].filter((item, index) => checks[index]);
+	return filterIterable(
+		collection,
+		await Promise.all(mapIterable(collection, callback))
+	);
 };

src/async-filter.js

@@ -4,6 +4,7 @@ const { mapIterable } = require('./helpers'),
 
 /**
  * Async Find Index
+ * ================
  * Find an item's index in an iterable object asynchronously and resolve when found or all callbacks resolve
  * @async
  * @param {Function} callback - callback(currentValue, index, array)

src/async-find-index.js

@@ -4,6 +4,7 @@ const { mapIterable } = require('./helpers'),
 
 /**
  * Async Find
+ * ==========
  * Find an item in an iterable object asynchronously and resolve when found or all callbacks resolve
  * @async
  * @param {Function} callback - callback(currentValue, index, array)
@@ -19,18 +20,20 @@ module.exports = async function asyncFind(callback, thisArg = noParam) {
 
 	const tasks = mapIterable(collection, callback);
 
-	const index = await Promise.race([
-		Promise.race(
-			tasks.map(async (task, index) => {
-				const checkIsFound = await task;
+	return collection[
+		await Promise.race([
+			Promise.race(
+				tasks.map(async (task, index) => {
+					const checkIsFound = await task;
 
-				return new Promise(resolve => checkIsFound && resolve(index));
-			})
-		),
-		Promise.all(tasks).then(taskResults =>
-			taskResults.findIndex(result => result)
-		)
-	]);
-
-	return collection[index];
+					return new Promise(
+						resolve => checkIsFound && resolve(index)
+					);
+				})
+			),
+			Promise.all(tasks).then(taskResults =>
+				taskResults.findIndex(result => result)
+			)
+		])
+	];
 };

src/async-find.js

@@ -4,6 +4,7 @@ const { mapIterable } = require('./helpers'),
 
 /**
  * Async For Each
+ * ==============
  * Loop over an iterable object asynchronously and resolve when all callbacks are resolved
  * @async
  * @param {Function} callback - callback(currentValue, index, array)

src/async-for-each.js

@@ -4,6 +4,7 @@ const { mapIterable } = require('./helpers'),
 
 /**
  * Async Map
+ * =========
  * Map an iterable object asynchronously and resolve when all callbacks are resolved
  * @async
  * @param {Function} callback - callback(currentValue, index, array)