Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wilk/microjob
A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads.
https://github.com/wilk/microjob
jobs multithreading nodejs thread threading
Last synced: about 1 month ago
JSON representation
A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads.
- Host: GitHub
- URL: https://github.com/wilk/microjob
- Owner: wilk
- License: mit
- Created: 2018-08-26T09:31:59.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T13:11:29.000Z (over 1 year ago)
- Last Synced: 2024-04-18T13:27:19.345Z (2 months ago)
- Topics: jobs, multithreading, nodejs, thread, threading
- Language: TypeScript
- Homepage: https://wilk.github.io/microjob/
- Size: 1.95 MB
- Stars: 2,019
- Watchers: 28
- Forks: 47
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-list - microjob - to-use routines for heavy CPU loads. | wilk | 1969 | (TypeScript)
- awesome-stars - microjob - to-use routines for heavy CPU loads. | wilk | 2024 | (TypeScript)
- awesome - wilk/microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- awesome-stars - microjob - to-use routines for heavy CPU loads. | wilk | 2024 | (TypeScript)
- awesome - wilk/microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- awesome-stars - wilk/microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- awesome-stars - wilk/microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- awesome-stars - microjob - to-use routines for heavy CPU loads. | wilk | 1827 | (TypeScript)
- awesome-stars - microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- my-awesome-stars - wilk/microjob - A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads. (TypeScript)
- awesome-repos - microjob
README
# Microjob
[](https://badge.fury.io/js/microjob)
[](https://travis-ci.org/wilk/microjob)
[](https://coveralls.io/github/wilk/microjob?branch=feature%2Fcoverage)
[](https://david-dm.org/wilk/microjob?path=packages/microjob)
A tiny wrapper for turning [Node.js threads](https://nodejs.org/api/worker_threads.html) in easy-to-use routines for CPU-bound.
## Introduction
Microjob is a tiny wrapper for Node.js threads and is intended to perform heavy CPU loads using anonymous functions.
~~So, Microjob treats Node.js threads as temporary working units: if you need to spawn a long-living thread, then you should use the [default API](https://nodejs.org/api/worker_threads.html).~~
From version v0.1.0 microjob uses a **[Worker Pool](GUIDE.md#worker-pool)** ð
Microjob follows the same line of the original Node.js documentation: use it only for CPU-bound jobs and not for I/O-bound purposes.
Quoting the documentation:
> Workers are useful for performing CPU-intensive JavaScript operations; do not use them for I/O, since Node.jsâs built-in mechanisms for performing operations asynchronously already treat it more efficiently than Worker threads can.
**Microjob** can be used with **Node.js 12+** without flag. With **Node.js 10.5+** you need the **--experimental-worker** flag activated, otherwise it won't work.
More details explained in: **[Microjob: a tiny multithreading library for Node.js](https://medium.com/hackernoon/microjob-a-tiny-multithreading-library-for-node-js-92d0500b07d5)**
## Installation
Via **npm**:
```bash
$ npm install --save microjob
```
## Quick Example
```js
(async () => {
const { job, start, stop } = require("microjob");
try {
// start the worker pool
await start();
// this function will be executed in another thread
const res = await job(() => {
let i = 0;
for (i = 0; i < 1000000; i++) {
// heavy CPU load ...
}
return i;
});
console.log(res); // 1000000
} catch (err) {
console.error(err);
} finally {
// shutdown worker pool
await stop();
}
})();
```
## Features
- ð¢ïž Worker Pool
- ð¥ auto self-healing
- ð easy and simple
- ð supports both sync and async jobs
- ð¡ïž huge test coverage
- ð well documented
## Documentation
Dive deep into the documentation to find more examples: **[Guide](GUIDE.md)**
## Known Issues
- **[sanitize worker context](GUIDE.md#job-context)**
## Known Limitations
- **[serialize worker data](GUIDE.md#job-data)**
- **[passing runtime context](GUIDE.md#job-context)**