@clipboard-health/util-ts 4.6.77 → 4.7.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/util-ts",
   "description": "TypeScript utilities.",
-  "version": "4.6.77",
+  "version": "4.7.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.1"

package/src/lib/arrays/forEachAsyncSequentially.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Iterates over an array and applies an async function to each item sequentially.
+ *
+ * Usages of this function should be intentional. If it's possible to parallelize the tasks, you
+ * should use `.map` and `Promise.all()` instead, or you could batch promises together with some
+ * limit. Only uses this when order matters or when parallel execution would cause issues (e.g.,
+ * rate limiting, database transactions).
+ *
+ *
+ * @param array - The array to iterate over.
+ * @param asyncTask - The async function to apply to each item.
+ * @example
+ *   const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ *   await forEachAsyncSequentially(users, async (user) => {
+ *     await sendEmail(user.id);
+ *   });
+ */
+export declare function forEachAsyncSequentially<T>(array: T[], asyncTask: (item: T, index: number) => Promise<unknown>): Promise<void>;

package/src/lib/arrays/forEachAsyncSequentially.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forEachAsyncSequentially = forEachAsyncSequentially;
+/**
+ * Iterates over an array and applies an async function to each item sequentially.
+ *
+ * Usages of this function should be intentional. If it's possible to parallelize the tasks, you
+ * should use `.map` and `Promise.all()` instead, or you could batch promises together with some
+ * limit. Only uses this when order matters or when parallel execution would cause issues (e.g.,
+ * rate limiting, database transactions).
+ *
+ *
+ * @param array - The array to iterate over.
+ * @param asyncTask - The async function to apply to each item.
+ * @example
+ *   const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ *   await forEachAsyncSequentially(users, async (user) => {
+ *     await sendEmail(user.id);
+ *   });
+ */
+async function forEachAsyncSequentially(array, asyncTask) {
+    for (const [index, item] of array.entries()) {
+        // eslint-disable-next-line no-await-in-loop
+        await asyncTask(item, index);
+    }
+}
+//# sourceMappingURL=forEachAsyncSequentially.js.map

package/src/lib/arrays/forEachAsyncSequentially.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forEachAsyncSequentially.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/arrays/forEachAsyncSequentially.ts"],"names":[],"mappings":";;AAiBA,4DAQC;AAzBD;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,KAAU,EACV,SAAuD;IAEvD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,4CAA4C;QAC5C,MAAM,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC"}

package/src/lib/arrays/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./chunk";
+export * from "./forEachAsyncSequentially";
 export * from "./head";
 export * from "./nonEmptyArray";

package/src/lib/arrays/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./chunk"), exports);
+tslib_1.__exportStar(require("./forEachAsyncSequentially"), exports);
 tslib_1.__exportStar(require("./head"), exports);
 tslib_1.__exportStar(require("./nonEmptyArray"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/arrays/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/arrays/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iDAAuB;AACvB,0DAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/arrays/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,qEAA2C;AAC3C,iDAAuB;AACvB,0DAAgC"}