# worker-threads-promise

> Worker threads with promise support

Latest version **1.0.1** (published 2019-10-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install worker-threads-promise
pnpm add worker-threads-promise
yarn add worker-threads-promise
bun add worker-threads-promise
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-10-08 |
| First published | 2019-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | ahmetcanguven44@gmail.com |
| Maintainers | acanguven |

## Links

- npm: https://www.npmjs.com/package/worker-threads-promise
- Repository: https://github.com/Acanguven/worker-threads-promise
- Homepage: https://github.com/Acanguven/worker-threads-promise#readme
- Issues: https://github.com/Acanguven/worker-threads-promise/issues
- npm.io page: https://npm.io/package/worker-threads-promise

## Dependencies (1)

- [hyperid](https://npm.io/package/hyperid.md) ^2.0.2

## Recent versions

- 1.0.1 (latest) — 2019-10-08
- 1.0.0 — 2019-10-08

## README

# Worker Threads Promise
Worker Threads implementation with promises to support request-response communication between master and child thread.

If you are using Node version 12- be sure to use the argument `--experimental-workers`.

Promise implementation adds very low latency that can be considered as unimportant.

## Install
```bash
npm i worker-threads-promise
```

## Usage


*./main.js*
```js
const Worker = require('worker-threads-promise');
const path = require('path');

const worker = new Worker(path.join(__dirname, './worker.js'));

(async () => {
  const res = await worker.postMessageAsync(1000);
  console.log(res);

})();
```

*./worker.js*
```js
const {parentPort} = require('worker_threads');
const Worker = require('worker-threads-promise');
Worker.connect(parentPort);

parentPort.on('message', data => { //you can use await too
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(data);
    }, data);
  });
});
```


## Options

### Timeout
It will throw timeout exceed error after given amount of milliseconds. 

Default: No Timeout

*./main.js*
```js
const Worker = require('worker-threads-promise');
const path = require('path');

const worker = new Worker(path.join(__dirname, './worker.js'));

(async () => {
  const res = await worker.postMessageAsync(5000, {
    timeout: 1000
  }).catch(e => {
    console.log(e);
  });
})();
```

*./worker.js*
```js
const {parentPort} = require('worker_threads');
const Worker = require('worker-threads-promise');
Worker.connect(parentPort);

parentPort.on('message', data => {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(data);
    }, data);
  });
});
```

### Unref
It will prevent event loop to remain active when waiting for response.

Default: `false`

*./main.js*
```js
const Worker = require('worker-threads-promise');
const path = require('path');

const worker = new Worker(path.join(__dirname, './worker.js'));

(async () => {
  const res = await worker.postMessageAsync(5000, {
    timeout: 1000,
    unref: true
  }).catch(e => {
    console.log(e);
  });
})();
```

*./worker.js*
```js
const {parentPort} = require('worker_threads');
const Worker = require('worker-threads-promise');
Worker.connect(parentPort);

parentPort.on('message', data => {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(data);
    }, data);
  });
});
```

### transferList
You can also use transfer list for async calls, you may use 3rd parameter for them.

```js
await worker.postMessageAsync(5000, null, []);
```

As `worker-threads-promise` extends native `Worker`, you can use all other features of Worker classes using instance of `worker-threads-promise`.

---
_Source: https://npm.io/package/worker-threads-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._