https://github.com/zy445566/ncpu
multi-threaded library that node.js run function worker
https://github.com/zy445566/ncpu
function nodejs threads worker
Last synced: 2 months ago
JSON representation
multi-threaded library that node.js run function worker
- Host: GitHub
- URL: https://github.com/zy445566/ncpu
- Owner: zy445566
- License: mit
- Created: 2020-09-04T10:26:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-09T12:01:09.000Z (over 3 years ago)
- Last Synced: 2024-10-31T20:43:14.271Z (8 months ago)
- Topics: function, nodejs, threads, worker
- Language: TypeScript
- Homepage: https://github.com/zy445566/ncpu
- Size: 33.2 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ncpu
multi-threaded library that node.js run function worker
# Installation
```sh
npm install ncpu
```
[ncpu](https://github.com/zy445566/ncpu) for the **`node.js`** environment,use [ncpu-web](https://github.com/zy445566/ncpu-web) for the **`browser`** environment.
`require:Node.js version>=12`
# Attention
Because it is multithreaded, context information cannot be received and parameter passing can only be achieved by cloning(
The cloning will occur as described in the [HTML structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), and an error will be thrown if the object cannot be cloned (e.g. because it contains functions)).
# Quick Start
```js
import {NCPU} from 'ncpu' // or const {NCPU} = require('ncpu')
async function main () {
// ### run
await NCPU.run((a,b)=>a+b,[1,2]) // result: 3
await NCPU.run((list)=>{
return list.reduce((total,value)=>{return total+value;});
},[[1,2,3]]) // result: 6
// ### pick
const workerFibo = await NCPU.pick((num)=>{
const fibo = (value)=>{
if(value<=2){return 1;}
return fibo(value-2)+fibo(value-1);
}
return fibo(num);
});
// slef time to run
await workerFibo(38)+await workerFibo(39) // result: 102334155 //fibo(40)
// ### getWorker // reuse a thread
const ncpuWorker = NCPU.getWorker();
const multiplexingWorkerFibo = await NCPU.pick((num)=>{
const fibo = (value)=>{
if(value<=2){return 1;}
return fibo(value-2)+fibo(value-1);
}
return fibo(num);
}, {ncpuWorker}); // reuse a thread
const res = await Promise.all([multiplexingWorkerFibo(38), NCPU.run((num)=>{
const fibo = (value)=>{
if(value<=2){return 1;}
return fibo(value-2)+fibo(value-1);
}
return fibo(num);
}, [39] ,{ncpuWorker})]); // reuse a thread
// ### inject globalData
await NCPU.run(()=>{
return require('fs') === require('fs');
},[],{injectList:['require']}) // result: true
}
main()
```
The above example spawns a Worker thread for each callback function when runing. In actual practice, use a pool of Workers instead for these kinds of tasks. Otherwise, the overhead of creating Workers would likely exceed their benefit.
# Other solutions
* [pambdajs](https://github.com/tim-hub/pambdajs)
* [napajs](https://github.com/microsoft/napajs)
# License
[ncpu](https://github.com/zy445566/ncpu) is available under the MIT license. See the [LICENSE](https://github.com/zy445566/ncpu/blob/master/LICENSE) file for details.