node-worker-pool-lite 0.1.0 → 0.1.2

package/README.md

@@ -1,13 +1,16 @@
-# Worker Pool
+# Node Worker Pool Lite
+
+[![npm version](https://img.shields.io/npm/v/node-worker-pool-lite.svg)](https://www.npmjs.com/package/node-worker-pool-lite)
+[![license](https://img.shields.io/npm/l/node-worker-pool-lite.svg)](https://github.com/armanmikoyan/node-worker-pool/blob/main/LICENSE)
 
 A lightweight Node.js `worker_threads` pool with callback and Promise APIs.
 
-Worker Pool helps you move CPU-heavy work off the main event loop while keeping a small, predictable API. It supports named worker tasks, a fixed-size worker pool, queued jobs, worker replacement after failures, and TypeScript declarations.
+Node Worker Pool Lite helps you move CPU-heavy work off the main event loop while keeping a small, predictable API. It supports named worker tasks, a fixed-size worker pool, queued jobs, worker replacement after failures, and TypeScript declarations.
 
 ## Features
 
 - Callback-first API from the main package entrypoint.
-- Promise API from `worker-pool/promise`.
+- Promise API from `node-worker-pool-lite/promise`.
 - Named task handlers inside worker files.
 - Automatic task queueing when all workers are busy.
 - Worker error propagation to callbacks or rejected promises.
@@ -22,13 +25,7 @@ Worker Pool helps you move CPU-heavy work off the main event loop while keeping
 ## Installation
 
 ```sh
-npm install worker-pool
-```
-
-If you publish this under a scoped package name, install it with your final package name instead:
-
-```sh
-npm install @your-username/worker-pool
+npm install node-worker-pool-lite
 ```
 
 ## Quick Start
@@ -37,7 +34,7 @@ Create a worker file with named task handlers:
 
 ```js
 // worker.js
-import { createWorkerHandler } from 'worker-pool';
+import { createWorkerHandler } from 'node-worker-pool-lite';
 
 createWorkerHandler({
   double(value) {
@@ -54,7 +51,7 @@ Run tasks with the callback API:
 
 ```js
 // index.js
-import { WorkerPool } from 'worker-pool';
+import { WorkerPool } from 'node-worker-pool-lite';
 
 const pool = new WorkerPool(new URL('./worker.js', import.meta.url), {
   size: 4,
@@ -74,10 +71,10 @@ pool.run('double', 21, async (error, result) => {
 
 ## Promise API
 
-Import from `worker-pool/promise` when you prefer `async` / `await`:
+Import from `node-worker-pool-lite/promise` when you prefer `async` / `await`:
 
 ```js
-import { WorkerPool } from 'worker-pool/promise';
+import { WorkerPool } from 'node-worker-pool-lite/promise';
 
 const pool = new WorkerPool(new URL('./worker.js', import.meta.url), {
   size: 4,
@@ -96,7 +93,7 @@ try {
 Workers are registered with `createWorkerHandler()`. Each key is the task name used by `pool.run()`.
 
 ```js
-import { createWorkerHandler } from 'worker-pool';
+import { createWorkerHandler } from 'node-worker-pool-lite';
 
 createWorkerHandler({
   resizeImage(payload) {
@@ -157,7 +154,7 @@ pool.run('refreshCache', error => {
 });
 ```
 
-### `pool.run(name, payload)` from `worker-pool/promise`
+### `pool.run(name, payload)` from `node-worker-pool-lite/promise`
 
 Queues a named task and returns a promise.
 
@@ -208,16 +205,19 @@ Preview the package contents before publishing:
 npm pack --dry-run
 ```
 
-## Publishing Notes
+## Repository
+
+- GitHub: [armanmikoyan/node-worker-pool](https://github.com/armanmikoyan/node-worker-pool)
+- npm: [node-worker-pool-lite](https://www.npmjs.com/package/node-worker-pool-lite)
+
+## Release Checklist
 
-Before publishing to npm:
+Before publishing a new npm version:
 
-- Choose a unique package name and update `package.json`.
-- Add `author`, `repository`, `homepage`, and `bugs` fields to `package.json`.
-- Update `LICENSE` with your name.
 - Run `npm test` and `npm pack --dry-run`.
-- Publish scoped public packages with `npm publish --access public`.
+- Update the version with `npm version patch`, `npm version minor`, or `npm version major`.
+- Publish with `npm publish`.
 
 ## License
 
-MIT
+MIT © [Arman Mikoyan](https://github.com/armanmikoyan)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "node-worker-pool-lite",
   "author": "Arman Mikoyan <arman@mikoyan1@gmail.com>",
-  "version": "0.1.0",
-  "description": "A lightweight callback and promise worker_threads pool for Node.js.",
+  "version": "0.1.2",
+  "description": "A lightweight Node.js worker_threads pool with callback and Promise APIs.",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,24 +18,42 @@
   },
   "files": [
     "lib",
-    "examples",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
     "test": "node --test test/*.test.js"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/armanmikoyan/node-worker-pool.git"
+  },
+  "homepage": "https://github.com/armanmikoyan/node-worker-pool#readme",
+  "bugs": {
+    "url": "https://github.com/armanmikoyan/node-worker-pool/issues"
+  },
   "keywords": [
+    "node",
+    "nodejs",
     "worker_threads",
     "worker-pool",
+    "worker-thread-pool",
     "thread-pool",
     "concurrency",
+    "parallel",
+    "parallel-processing",
     "pool",
     "parallelism",
-    "cpu-intensive"
+    "cpu-intensive",
+    "cpu-bound",
+    "background-jobs",
+    "task-queue",
+    "esm",
+    "typescript"
   ],
   "engines": {
     "node": ">=18"
   },
+  "sideEffects": false,
   "license": "MIT"
 }

package/examples/basic.js

@@ -1,24 +0,0 @@
-import { WorkerPool } from '../lib/index.js';
-
-const pool = new WorkerPool(new URL('./prime-worker.js', import.meta.url), {
-  size: 3,
-});
-
-let pendingTasks = 2;
-
-pool.run('primes', { count: 10 }, handleResult);
-pool.run('primes', { count: 20 }, handleResult);
-
-async function handleResult(error, primes) {
-  pendingTasks -= 1;
-
-  if (error) {
-    console.error(error);
-  } else {
-    console.log(primes);
-  }
-
-  if (pendingTasks === 0) {
-    await pool.destroy();
-  }
-}

package/examples/prime-worker.js

@@ -1,36 +0,0 @@
-import { createWorkerHandler } from '../lib/index.js';
-
-createWorkerHandler({
-  primes({ count = 1 } = {}) {
-    return generatePrimes(count);
-  },
-});
-
-function generatePrimes(count) {
-  const primes = [];
-  let candidate = 2;
-
-  while (primes.length < count) {
-    if (isPrime(candidate)) {
-      primes.push(candidate);
-    }
-
-    candidate += 1;
-  }
-
-  return primes;
-}
-
-function isPrime(value) {
-  if (value < 2) {
-    return false;
-  }
-
-  for (let divisor = 2; divisor * divisor <= value; divisor += 1) {
-    if (value % divisor === 0) {
-      return false;
-    }
-  }
-
-  return true;
-}

package/examples/promise.js

@@ -1,17 +0,0 @@
-import { WorkerPool } from '../lib/promise.js';
-
-const pool = new WorkerPool(new URL('./prime-worker.js', import.meta.url), {
-  size: 3,
-});
-
-try {
-  const [firstBatch, secondBatch] = await Promise.all([
-    pool.run('primes', { count: 10 }),
-    pool.run('primes', { count: 20 }),
-  ]);
-
-  console.log(firstBatch);
-  console.log(secondBatch);
-} finally {
-  await pool.destroy();
-}