@altano/tiny-async-pool 1.0.3 → 3.0.0

package/README.md

@@ -1,5 +1,7 @@
 # tiny-async-pool
 
+This is an ESM + TypeScript fork of [tiny-async-pool](https://www.npmjs.com/package/tiny-async-pool) by Rafael Xavier de Souza, with some added functionality.
+
 ## Why?
 
 The goal of this library is to use the native async iterator (ES9), native async functions, and native Promise to implement concurrent/batched work.
@@ -69,17 +71,18 @@ Iterator function that takes two arguments: the value of each iteration and the
 
 ### `doWork(concurrency, iterable, iteratorFn)`
 
-The same as `doWorkAndYield(...)` but just returns a Promise that resolves when all work resolves/rejects, e.g.:
+Like `doWorkAndYield(...)` but with a simpler API. Useful when you don't care about the return value of `iteratorFn`, such as a worker pool where you do batch file proccessing and the workers produce a side effect instead of returning a value.
 
-```js
-const timeout = (ms) => new Promise((resolve) => setTimeout(() => resolve(ms), ms));
+For example, a batch file eraser is as simple as:
 
-await doWork(2, [1000, 5000, 3000, 2000], timeout);
+```js
+const eraseFile = (path) => fs.unlink(path);
+const eraseFiles = async (files) => doWork(4, files, eraseFile);
 ```
 
-## License
+It will be enforced that `iteratorFn` returns `Promise<void>` when using TypeScript.
 
-This project is a fork of `async-pool` by Rafael Xavier de Souza. It modernizes (as of 2022) the library by being a first-class TypeScript and ESM module.
+## License
 
 MIT © [Rafael Xavier de Souza](http://rafael.xavier.blog.br)
 MIT © [Alan Norbauer](https://alan.norbauer.com)

package/dist/doWork.d.ts

@@ -1,6 +1,21 @@
-import { doWorkAndYield } from "./doWorkAndYield";
+import { type IterableItem } from "./doWorkAndYield";
 /**
  * Process items from `iterable` in batches.
  */
-export declare function doWork<TIn, TOut, TIterable extends Iterable<TIn>>(...args: Parameters<typeof doWorkAndYield<TIn, TOut, TIterable>>): Promise<void>;
+export declare function doWork<TIn, TIterable extends Iterable<TIn>>(
+/**
+ * The size of the batch of work, or, how many times `iteratorFn` will be
+ * called in parallel.
+ */
+concurrentCount: number, 
+/**
+ * An iterable that contains the items that should be passed to `iteratorFn`.
+ */
+iterable: TIterable, 
+/**
+ * The async callback function that does the work. Will be passed items from
+ * `iterable`. Promise returned must not resolve to a value, as it will be
+ * ignored.
+ */
+iteratorFn: (item: IterableItem<TIterable>, Iterable: TIterable) => Promise<void>): Promise<void>;
 //# sourceMappingURL=doWork.d.ts.map

package/dist/doWork.js

@@ -0,0 +1,12 @@
+import { doWorkAndYield } from "./doWorkAndYield";
+async function doWork(concurrentCount, iterable, iteratorFn) {
+  for await (const _result of doWorkAndYield(
+    concurrentCount,
+    iterable,
+    iteratorFn
+  )) {
+  }
+}
+export {
+  doWork
+};

package/dist/doWorkAndYield.d.ts

@@ -1,4 +1,4 @@
-type IterableItem<T> = T extends Iterable<infer R> ? R : never;
+export type IterableItem<T> = T extends Iterable<infer R> ? R : never;
 /**
  * Process items from `iterable` in batches and yield the result of each call to
  * `iteratorFn`
@@ -18,5 +18,4 @@ iterable: TIterable,
  * `iterable`.
  */
 iteratorFn: (item: IterableItem<TIterable>, Iterable: TIterable) => Promise<TOut>): AsyncGenerator<Awaited<TOut>, void, unknown>;
-export {};
 //# sourceMappingURL=doWorkAndYield.d.ts.map

package/dist/doWorkAndYield.js

@@ -0,0 +1,25 @@
+async function* doWorkAndYield(concurrentCount, iterable, iteratorFn) {
+  const executing = /* @__PURE__ */ new Set();
+  async function consume() {
+    const [promise, value] = await Promise.race(executing);
+    executing.delete(promise);
+    return value;
+  }
+  for (const item of iterable) {
+    const result = iteratorFn(item, iterable);
+    const promise = result.then((value) => [
+      promise,
+      value
+    ]);
+    executing.add(promise);
+    if (executing.size >= concurrentCount) {
+      yield await consume();
+    }
+  }
+  while (executing.size) {
+    yield await consume();
+  }
+}
+export {
+  doWorkAndYield
+};

package/dist/index.js

@@ -1,33 +1,2 @@
-// src/doWorkAndYield.ts
-async function* doWorkAndYield(concurrentCount, iterable, iteratorFn) {
-  const executing = /* @__PURE__ */ new Set();
-  async function consume() {
-    const [promise, value] = await Promise.race(executing);
-    executing.delete(promise);
-    return value;
-  }
-  for (const item of iterable) {
-    const result = iteratorFn(item, iterable);
-    const promise = result.then((value) => [
-      promise,
-      value
-    ]);
-    executing.add(promise);
-    if (executing.size >= concurrentCount) {
-      yield await consume();
-    }
-  }
-  while (executing.size) {
-    yield await consume();
-  }
-}
-
-// src/doWork.ts
-async function doWork(...args) {
-  for await (const _result of doWorkAndYield(...args)) {
-  }
-}
-export {
-  doWork,
-  doWorkAndYield
-};
+export * from "./doWork";
+export * from "./doWorkAndYield";

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "@altano/tiny-async-pool",
-  "version": "1.0.3",
+  "version": "3.0.0",
   "description": "Run multiple promise-returning & async functions with limited concurrency using native ES9",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "./dist/index.d.ts",
+  "exports": "./dist/index.js",
   "type": "module",
   "sideEffects": false,
   "files": [
-    "LICENSE-MIT",
     "dist/**/*.js",
-    "dist/**/*.d.ts",
-    "README.md"
+    "dist/**/*.d.ts"
   ],
   "repository": {
     "type": "git",
@@ -39,33 +37,34 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^20.11.25",
-    "@types/prettier": "^3.0.0",
+    "@vitest/coverage-v8": "^1.4.0",
     "@vitest/ui": "^1.3.1",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.57.0",
     "mocha": "^10.3.0",
     "prettier": "^3.2.5",
-    "tsup": "^8.0.2",
     "typescript": "^5.4.2",
-    "vitest": "^1.3.1",
+    "vitest": "^1.4.0",
     "@altano/tsconfig": "0.0.0",
-    "eslint-config-altano": "0.0.1"
+    "eslint-config-altano": "0.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --onSuccess \"pnpm build:types\"",
-    "build:types": "tsc --emitDeclarationOnly --declaration",
-    "dev": "tsup src/index.ts --watch --format esm --dts",
+    "build": "tsup --config build-config/tsup.config.node.ts",
+    "build:types": "tsc --project tsconfig.declarations.json",
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
+    "dev": "pnpm run build --watch",
     "format": "prettier --check src",
     "format:fix": "prettier --write src",
-    "lint": "eslint src/**/*.ts*",
-    "lint:timing": "TIMING=1 eslint src/**/*.ts*",
-    "lint:fix": "TIMING=1 eslint src/**/*.ts* --fix",
-    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
-    "test": "vitest --run",
-    "test:watch": "vitest"
+    "lint": "eslint package.json src/**/*.ts*",
+    "lint:fix": "TIMING=1 pnpm lint --fix",
+    "lint:timing": "TIMING=1 pnpm lint",
+    "test:unit": "vitest --run",
+    "test:unit:watch": "vitest",
+    "typecheck:src": "tsc --noEmit",
+    "typecheck:test": "tsc --noEmit --project ./tests/tsconfig.json"
   }
 }