tinypool - npm Package Compare versions
Comparing version 0.9.0 to 1.0.0
@@ -29,7 +29,11 @@ import { | ||
| } | ||
| send({ | ||
| ready: true, | ||
| source: "pool", | ||
| __tinypool_worker_message__: true | ||
| }); | ||
| send( | ||
| { | ||
| ready: true, | ||
| source: "pool", | ||
| __tinypool_worker_message__: true | ||
| }, | ||
| () => { | ||
| } | ||
| ); | ||
| })().catch(throwInNextTick); | ||
@@ -36,0 +40,0 @@ return; |
| { | ||
| "name": "tinypool", | ||
| "type": "module", | ||
| "version": "0.9.0", | ||
| "version": "1.0.0", | ||
| "packageManager": "pnpm@9.0.6", | ||
| "description": "A minimal and tiny Node.js Worker Thread Pool implementation, a fork of piscina, but with fewer features", | ||
@@ -35,19 +36,7 @@ "license": "MIT", | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^20.12.8", | ||
| "clean-publish": "^3.4.4", | ||
| "husky": "^7.0.4", | ||
| "nano-staged": "^0.5.0", | ||
| "prettier": "^2.5.1", | ||
| "tsup": "^8.0.2", | ||
| "typescript": "^5.4.5", | ||
| "vite": "^5.2.11", | ||
| "vitest": "^1.6.0" | ||
| }, | ||
| "scripts": { | ||
| "test": "vitest", | ||
| "bench": "vitest bench", | ||
| "dev": "tsup --watch", | ||
| "build": "tsup" | ||
| "pnpm": { | ||
| "overrides": { | ||
| "vitest>tinypool": "link:./" | ||
| } | ||
| } | ||
| } | ||
| } |
199
README.md
@@ -1,2 +0,1 @@ | ||
| # Tinypool - the node.js worker pool 🧵 | ||
@@ -16,199 +15,7 @@ | ||
| - Written in TypeScript, and ESM support only. For Node.js 14.x and higher. | ||
| - Written in TypeScript, and ESM support only. For Node.js 18.x and higher. | ||
| _In case you need more tiny libraries like tinypool or tinyspy, please consider submitting an [RFC](https://github.com/tinylibs/rfcs)_ | ||
| ## Example | ||
| ### Using `node:worker_threads` | ||
| #### Basic usage | ||
| ```js | ||
| // main.mjs | ||
| import Tinypool from 'tinypool' | ||
| const pool = new Tinypool({ | ||
| filename: new URL('./worker.mjs', import.meta.url).href, | ||
| }) | ||
| const result = await pool.run({ a: 4, b: 6 }) | ||
| console.log(result) // Prints 10 | ||
| // Make sure to destroy pool once it's not needed anymore | ||
| // This terminates all pool's idle workers | ||
| await pool.destroy() | ||
| ``` | ||
| ```js | ||
| // worker.mjs | ||
| export default ({ a, b }) => { | ||
| return a + b | ||
| } | ||
| ``` | ||
| #### Main thread <-> worker thread communication | ||
| <details> | ||
| <summary>See code</summary> | ||
| ```js | ||
| // main.mjs | ||
| import Tinypool from 'tinypool' | ||
| import { MessageChannel } from 'node:worker_threads' | ||
| const pool = new Tinypool({ | ||
| filename: new URL('./worker.mjs', import.meta.url).href, | ||
| }) | ||
| const { port1, port2 } = new MessageChannel() | ||
| const promise = pool.run({ port: port1 }, { transferList: [port1] }) | ||
| port2.on('message', (message) => console.log('Main thread received:', message)) | ||
| setTimeout(() => port2.postMessage('Hello from main thread!'), 1000) | ||
| await promise | ||
| port1.close() | ||
| port2.close() | ||
| ``` | ||
| ```js | ||
| // worker.mjs | ||
| export default ({ port }) => { | ||
| return new Promise((resolve) => { | ||
| port.on('message', (message) => { | ||
| console.log('Worker received:', message) | ||
| port.postMessage('Hello from worker thread!') | ||
| resolve() | ||
| }) | ||
| }) | ||
| } | ||
| ``` | ||
| </details> | ||
| ### Using `node:child_process` | ||
| #### Basic usage | ||
| <details> | ||
| <summary>See code</summary> | ||
| ```js | ||
| // main.mjs | ||
| import Tinypool from 'tinypool' | ||
| const pool = new Tinypool({ | ||
| runtime: 'child_process', | ||
| filename: new URL('./worker.mjs', import.meta.url).href, | ||
| }) | ||
| const result = await pool.run({ a: 4, b: 6 }) | ||
| console.log(result) // Prints 10 | ||
| ``` | ||
| ```js | ||
| // worker.mjs | ||
| export default ({ a, b }) => { | ||
| return a + b | ||
| } | ||
| ``` | ||
| </details> | ||
| #### Main process <-> worker process communication | ||
| <details> | ||
| <summary>See code</summary> | ||
| ```js | ||
| // main.mjs | ||
| import Tinypool from 'tinypool' | ||
| const pool = new Tinypool({ | ||
| runtime: 'child_process', | ||
| filename: new URL('./worker.mjs', import.meta.url).href, | ||
| }) | ||
| const messages = [] | ||
| const listeners = [] | ||
| const channel = { | ||
| onMessage: (listener) => listeners.push(listener), | ||
| postMessage: (message) => messages.push(message), | ||
| } | ||
| const promise = pool.run({}, { channel }) | ||
| // Send message to worker | ||
| setTimeout( | ||
| () => listeners.forEach((listener) => listener('Hello from main process')), | ||
| 1000 | ||
| ) | ||
| // Wait for task to finish | ||
| await promise | ||
| console.log(messages) | ||
| // [{ received: 'Hello from main process', response: 'Hello from worker' }] | ||
| ``` | ||
| ```js | ||
| // worker.mjs | ||
| export default async function run() { | ||
| return new Promise((resolve) => { | ||
| process.on('message', (message) => { | ||
| // Ignore Tinypool's internal messages | ||
| if (message?.__tinypool_worker_message__) return | ||
| process.send({ received: message, response: 'Hello from worker' }) | ||
| resolve() | ||
| }) | ||
| }) | ||
| } | ||
| ``` | ||
| </details> | ||
| ## API | ||
| We have a similar API to Piscina, so for more information, you can read Piscina's detailed [documentation](https://github.com/piscinajs/piscina#piscina---the-nodejs-worker-pool) and apply the same techniques here. | ||
| ### Tinypool specific APIs | ||
| #### Pool constructor options | ||
| - `isolateWorkers`: Disabled by default. Always starts with a fresh worker when running tasks to isolate the environment. | ||
| - `terminateTimeout`: Disabled by default. If terminating a worker takes `terminateTimeout` amount of milliseconds to execute, an error is raised. | ||
| - `maxMemoryLimitBeforeRecycle`: Disabled by default. When defined, the worker's heap memory usage is compared against this value after task has been finished. If the current memory usage exceeds this limit, worker is terminated and a new one is started to take its place. This option is useful when your tasks leak memory and you don't want to enable `isolateWorkers` option. | ||
| - `runtime`: Used to pick worker runtime. Default value is `worker_threads`. | ||
| - `worker_threads`: Runs workers in [`node:worker_threads`](https://nodejs.org/api/worker_threads.html). For `main thread <-> worker thread` communication you can use [`MessagePort`](https://nodejs.org/api/worker_threads.html#class-messageport) in the `pool.run()` method's [`transferList` option](https://nodejs.org/api/worker_threads.html#portpostmessagevalue-transferlist). See [example](#main-thread---worker-thread-communication). | ||
| - `child_process`: Runs workers in [`node:child_process`](https://nodejs.org/api/child_process.html). For `main thread <-> worker process` communication you can use `TinypoolChannel` in the `pool.run()` method's `channel` option. For filtering out the Tinypool's internal messages see `TinypoolWorkerMessage`. See [example](#main-process---worker-process-communication). | ||
| #### Pool methods | ||
| - `cancelPendingTasks()`: Gracefully cancels all pending tasks without stopping or interfering with on-going tasks. This method is useful when your tasks may have side effects and should not be terminated forcefully during task execution. If your tasks don't have any side effects you may want to use [`{ signal }`](https://github.com/piscinajs/piscina#cancelable-tasks) option for forcefully terminating all tasks, including the on-going ones, instead. | ||
| - `recycleWorkers(options)`: Waits for all current tasks to finish and re-creates all workers. Can be used to force isolation imperatively even when `isolateWorkers` is disabled. Accepts `{ runtime }` option as argument. | ||
| #### Exports | ||
| - `workerId`: Each worker now has an id ( <= `maxThreads`) that can be imported from `tinypool` in the worker itself (or `process.__tinypool_state__.workerId`). | ||
| ## Authors | ||
| | <a href="https://github.com/Aslemammad"> <img width='150' src="https://avatars.githubusercontent.com/u/37929992?v=4" /><br> Mohammad Bagher </a> | | ||
| | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| ## Sponsors | ||
| Your sponsorship can make a huge difference in continuing our work in open source! | ||
| <p align="center"> | ||
| <a href="https://cdn.jsdelivr.net/gh/aslemammad/static/sponsors.svg"> | ||
| <img src='https://cdn.jsdelivr.net/gh/aslemammad/static/sponsors.svg'/> | ||
| </a> | ||
| </p> | ||
| ## Credits | ||
| [The Vitest team](https://vitest.dev/) for giving me the chance of creating and maintaing this project for vitest. | ||
| [Piscina](https://github.com/piscinajs/piscina), because Tinypool is not more than a friendly fork of piscina. | ||
| ## Docs | ||
| Read **[full docs](https://github.com/tinylibs/tinypool#readme)** on GitHub. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Dev dependency count
- decreased by-100%
0
- Lines of code
- increased by0.25%
1578
- Number of low quality alerts
- decreased by-100%
0
- Number of medium supply chain risk alerts
- decreased by-25%
3
Worsened metrics
- Total package byte prevSize
- decreased by-11.61%
49741
- Number of lines in readme file
- decreased by-90.19%
21
No dependency changes