Merge pull request #85 from Sykander/async-map-sort-specs

Async Map Sort Specs

Author: Sykander

README.md

@@ -38,6 +38,7 @@ An Array class with additional async array methods.
 | **asyncFindIndex** | Find an item's index in an iterable object asynchronously | [wiki](https://github.com/Sykander/iterable-async/wiki/Async-Find-Index) |
 | **asyncForEach** | Loop over an iterable object asynchronously | [wiki](https://github.com/Sykander/iterable-async/wiki/Async-For-Each) |
 | **asyncMap** | Map an iterable object asynchronously | [wiki](https://github.com/Sykander/iterable-async/wiki/Async-Map) |
+| **asyncMapSort** | Map an iterable object asynchronously and then resolve when it's sorted, this method is much more efficient than running a regular `asyncSort` when done with a synchronous comparison function | [wiki](https://github.com/Sykander/iterable-async/wiki/Async-Map-Sort) |
 | **asyncSort** | Sort an iterable object asynchronously | [wiki](https://github.com/Sykander/iterable-async/wiki/Async-Sort) |
 
 ## Development

docs/playground.js

@@ -8,10 +8,11 @@ const users = [1, 2, 3, 4, 5].map(() => ({
 }));
 
 // Async Sort
-await AsyncArray.asyncSort(
+const sortedUsers = await AsyncArray.asyncSort(
 	users,
-	async ({ email: emailA }, { email: emailB }) => await emailA.localeCompare(emailB)
-).then(sortedUsers => {
-	console.log('Asynchronously sorted users');
-	console.table(sortedUsers);
-});
+	async ({ email: emailA }, { email: emailB }) =>
+		await emailA.localeCompare(emailB)
+);
+
+console.log('Asynchronously sorted users');
+console.table(sortedUsers);