# gearman-stream

> Allows streaming data from a Gearman job

Latest version **0.2.8** (published 2014-09-15) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install gearman-stream
pnpm add gearman-stream
yarn add gearman-stream
bun add gearman-stream
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.8 |
| Published | 2014-09-15 |
| First published | 2013-12-03 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Clever |
| Maintainers | azylman, templaedhel |
| Keywords | gearman, stream, clever |

## Links

- npm: https://www.npmjs.com/package/gearman-stream
- Repository: https://github.com/Clever/gearman-stream
- Issues: https://github.com/Clever/gearman-stream/issues
- npm.io page: https://npm.io/package/gearman-stream

## Dependencies (2)

- [underscore](https://npm.io/package/underscore.md) ~1.5.2
- [gearman-node](https://npm.io/package/gearman-node.md) ^2.0.6

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.2.8 (latest) — 2014-09-15
- 0.2.6 — 2014-07-17
- 0.2.5 — 2014-07-17
- 0.2.4 — 2014-03-21
- 0.2.3 — 2014-01-29
- 0.2.2 — 2014-01-08
- 0.2.1 — 2013-12-09
- 0.2.0 — 2013-12-06
- 0.1.2 — 2013-12-03
- 0.1.1 — 2013-12-03
- 0.1.0 — 2013-12-03

## README

# gearman-stream

`gearman-stream` is a stream that serves as a wrapper around a gearman client, allowing you to stream the payload and any worker data.

## Install
```
npm install gearman-stream
```

## Usage

`gearman-stream` supports taking the payload in two ways:

1. As a constructor option, in which case it's a `Readable` stream

2. From streaming data, in which case it's a `Transform` stream

## Examples

### Readable

```javascript
var GearmanStream = require('gearman-stream');

var gearmanOpts = {host: 'localhost', port: 4730};
var streamOpts = {highWaterMark: 10};
var payload = JSON.stringify([0, 1, 2, 3, 4, 5]);

// Stream that writes 10, 11, 12, 13, 14, 15
var add10Worker = new GearmanStream(streamOpts, gearmanOpts, 'add10', payload);
```

### Transform

*Note: The implementation or ArrayStream is left as an exercise to the reader.*

```javascript
var GearmanStream = require('gearman-stream');
var JSONStream = require('JSONStream');

var gearmanOpts = {host: 'localhost', port: 4730};
var streamOpts = {highWaterMark: 10};

var add10Worker = new GearmanStream(streamOpts, gearmanOpts, 'add10');
var readable = new ArrayStream([0, 1, 2, 3, 4, 5]);
var stringifyArray = JSONStream.stringify('[', ',', ']');
readable.pipe(stringifyArray).pipe(add10Worker); // 10, 11, 12, 13, 14, 15
```

### All together

```javascript
var GearmanStream = require('gearman-stream');
var JSONStream = require('JSONStream');

var gearmanOpts = {host: 'localhost', port: 4730};
var streamOpts = {highWaterMark: 10};
var payload = JSON.stringify([0, 1, 2, 3, 4, 5]);

var add10Worker = new GearmanStream(streamOpts, gearmanOpts, 'add10', payload);
var sumWorker = new GearmanStream(streamOpts, gearmanOpts, 'sum');
var stringifyArray = JSONStream.stringify('[', ',', ']');
add10Worker.pipe(stringifyArray).pipe(sumWorker) // 75
```

## Testing

You must have the Gearman daemon running.

    gearmand -d
    make test

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