smartspawn/README.md

53 lines
2.2 KiB
Markdown
Raw Normal View History

2018-08-02 13:31:05 +00:00
# @pushrocks/smartspawn
2016-09-28 12:22:23 +00:00
smart subprocess handling
2019-04-08 13:13:47 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartspawn)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartspawn)
* [github.com (source mirror)](https://github.com/pushrocks/smartspawn)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartspawn/)
2016-09-28 12:22:23 +00:00
## Status for master
2019-04-08 13:13:47 +00:00
[![build status](https://gitlab.com/pushrocks/smartspawn/badges/master/build.svg)](https://gitlab.com/pushrocks/smartspawn/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartspawn/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartspawn/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartspawn.svg)](https://www.npmjs.com/package/@pushrocks/smartspawn)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartspawn/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartspawn)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2016-09-28 12:22:23 +00:00
2017-03-03 19:55:54 +00:00
## Usage
2018-08-02 13:31:05 +00:00
2017-03-03 19:55:54 +00:00
Use TypeScript for best in class instellisense.
### Understand the Purpose
2018-08-02 13:31:05 +00:00
2016-09-28 12:22:23 +00:00
smartipc makes it easy to spawn tasks into subprocesses without loosing control over what those processes do.
You can transparently call functions and expect returned data using promises.
2017-03-03 19:55:54 +00:00
### How To
2016-09-28 12:22:23 +00:00
2017-01-29 22:46:09 +00:00
**Master.ts:**
2016-09-28 12:22:23 +00:00
2017-01-29 22:46:09 +00:00
```javascript
2018-08-02 13:31:05 +00:00
import * as smartspawn from 'smartspawn';
smartspawn.setBasePathArg(__dirname); // if you want to avoid typings out full paths every time
2016-09-28 12:22:23 +00:00
2018-08-02 13:31:05 +00:00
let myThread = new smartspawn.Thread('worker');
2017-01-29 22:46:09 +00:00
myThread.send('someMessageOrObject').then(messageResponse => {
2018-08-02 13:31:05 +00:00
console.log(messageResponse);
});
2016-09-28 12:22:23 +00:00
```
2017-01-29 22:46:09 +00:00
**worker.ts**
2016-09-28 12:22:23 +00:00
2017-01-29 22:46:09 +00:00
```javascript
2016-09-28 12:23:47 +00:00
```
2017-03-03 19:55:54 +00:00
2019-04-08 13:13:47 +00:00
For further information read the linked docs at the top of this readme.
2017-03-03 19:55:54 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-08-21 22:32:09 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
2017-03-03 19:55:54 +00:00
2019-08-21 22:32:09 +00:00
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)