feat: async map

Author: Soontao

src/async/allSettled.ts

@@ -0,0 +1,26 @@
+
+interface SettleResult<T = any> {
+  status: 'fulfilled' | 'rejected'
+  value?: T
+  reason?: any
+}
+
+/**
+ * Promise.allSettled() implementation
+ *
+ * @since 5.18.0
+ * @category Async
+ * @param collection
+ * @returns
+ */
+export async function allSettled<T = any>(collection: Array<Promise<T>>): Promise<Array<SettleResult<T>>> {
+  // @ts-ignore
+  return Promise.all(
+    collection
+      .map(
+        (item) => item
+          .then((value) => ({ status: 'fulfilled', value }))
+          .catch((reason) => ({ status: 'rejected', reason }))
+      )
+  );
+}

src/async/index.ts

@@ -1,11 +1,16 @@
+import { any } from '../any';
+import { allSettled } from './allSettled';
 import { filter } from './filter';
+import { map } from './map';
+
 
 /**
  * AsyncUtils
+ *
  * @since 5.18.0
  */
 export const AsyncUtils = {
-  filter
+  filter, map, allSettled, any
 };
 
 export default AsyncUtils;

src/async/map.ts

@@ -0,0 +1,27 @@
+import { map as syncMap } from '../map';
+import type { ArrayIteratee, RecordIteratee, Tuple } from '../types';
+import { allSettled } from './allSettled';
+
+
+/**
+ *
+ * AsyncUtils.map, mapping values with async iteratee functions
+ *
+ * @since 5.18.0
+ * @category Async
+ * @param collection
+ */
+export async function map<T extends any[] | []>(collection: T): Promise<Tuple<T>>;
+export async function map<T, R = any>(collection: ArrayLike<T>, iteratee?: ArrayIteratee<T, Promise<R>>): Promise<Array<R>>;
+export async function map<T, R = any>(collection: Record<string, T>, iteratee?: RecordIteratee<T, Promise<R>>): Promise<Array<R>>;
+export async function map(collection: any, iteratee?: any): Promise<Array<any>>;
+export async function map(collection: any, iteratee?: any) {
+  if (iteratee === undefined) {
+    return syncMap(collection);
+  }
+  const results = await allSettled(syncMap(collection, iteratee));
+  return syncMap(results, (result) => result.value ?? undefined);
+}
+
+
+export default map;

test/AsyncUtils.test.ts

@@ -11,9 +11,18 @@ describe('AsyncUtils Test Suite', () => {
       return (value % 2) === 0;
     });
 
-
     assert.deepStrictEqual(values, [2, 4]);
 
   });
 
+  it('should support async allSettled function', async () => {
+    const values = await AsyncUtils.allSettled([Promise.resolve(1), Promise.reject(2)]);
+    assert.deepStrictEqual(values, [{ status: 'fulfilled', value: 1 }, { status: 'rejected', reason: 2 }]);
+  });
+
+  it('should support async map function', async () => {
+    const values = await AsyncUtils.map([1, 2, 3], async (value) => value * value);
+    assert.deepStrictEqual(values, [1, 4, 9]);
+  });
+
 });

test/tsconfig.json

@@ -2,6 +2,7 @@
   "extends": "../tsconfig.base",
   "compilerOptions": {
     "checkJs": false,
-    "noStrictGenericChecks": true
+    "noStrictGenericChecks": true,
+    "declaration": false
   }
-}
+}

tsconfig.base.json

@@ -5,11 +5,23 @@
     "allowJs": true,
     "esModuleInterop": true,
     "moduleResolution": "node",
+    "module": "CommonJS",
     "declaration": true,
     "lib": [
       "ES2015",
       "ES2017",
+      "ES2020",
+      "ES2020.Promise",
       "DOM"
     ]
-  }
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "test",
+    "lib",
+    "dist",
+    "deno"
+  ]
 }

tsconfig.es5.json

@@ -1,28 +1,10 @@
 {
+  "extends": "./tsconfig.base",
   "compilerOptions": {
-    "charset": "UTF-8",
-    "newLine": "lf",
-    "allowJs": true,
     "target": "ES5",
     "module": "CommonJS",
     "outDir": "dist/es5",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "downlevelIteration": true,
     "declaration": true,
-    "lib": [
-      "ES6",
-      "ES2015.Symbol",
-      "ES2017",
-      "DOM"
-    ]
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "src/test",
-    "lib",
-    "dist"
-  ]
+    "downlevelIteration": true,
+  }
 }

tsconfig.es6.json

@@ -1,27 +1,9 @@
 {
+  "extends": "./tsconfig.base",
   "compilerOptions": {
-    "charset": "UTF-8",
-    "newLine": "lf",
-    "allowJs": true,
-    "target": "ES6",
-    "module": "ES6",
+    "target": "ES2015",
+    "module": "CommonJS",
     "outDir": "dist/es6",
-    "esModuleInterop": false,
-    "moduleResolution": "node",
     "declaration": true,
-    "lib": [
-      "ES6",
-      "ES2015.Symbol",
-      "ES2017",
-      "DOM"
-    ]
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "src/test",
-    "lib",
-    "dist"
-  ]
-}
+  }
+}

tsconfig.json

@@ -3,15 +3,6 @@
   "compilerOptions": {
     "target": "ES2018",
     "module": "CommonJS",
-    "outDir": "dist/node"
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "test",
-    "lib",
-    "dist",
-    "deno"
-  ]
+    "outDir": "dist/node",
+  }
 }

tsconfig.umd.json

@@ -1,22 +1,8 @@
 {
+  "extends": "./tsconfig.base",
   "compilerOptions": {
-    "charset": "UTF-8",
-    "newLine": "lf",
-    "allowJs": true,
-    "target": "ES6",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "lib": [
-      "ES6",
-      "ES2015.Symbol",
-      "ES2017",
-      "DOM"
-    ]
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "src/test"
-  ]
+    "target": "ES2015",
+    "outDir": "dist/umd",
+    "declaration": false,
+  }
 }