smartspawn/README.md

44 lines
2.1 KiB
Markdown
Raw Normal View History

2016-09-28 12:22:23 +00:00
# smartipc
smart subprocess handling
## Availabililty
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartipc)
[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartipc)
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartipc)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartipc/)
## Status for master
[![build status](https://gitlab.com/pushrocks/smartipc/badges/master/build.svg)](https://gitlab.com/pushrocks/smartipc/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartipc/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartipc/commits/master)
[![Dependency Status](https://david-dm.org/pushrocks/smartipc.svg)](https://david-dm.org/pushrocks/smartipc)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartipc/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartipc/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartipc/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartipc)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## The purpose
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.
## Usage
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
import * as smartipc from 'smartipc'
smartipc.setBasePathArg(__dirname) // if you want to avoid typings out full paths every time
2016-09-28 12:22:23 +00:00
2017-01-29 22:46:09 +00:00
let myThread = new smartipc.Thread('worker')
myThread.send('someMessageOrObject').then(messageResponse => {
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:22:23 +00:00
2016-09-28 12:23:47 +00:00
```
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)