File: readme.markdown

package info (click to toggle)
node-resumer 0.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 136 kB
  • ctags: 27
  • sloc: sh: 11; makefile: 10
file content (59 lines) | stat: -rw-r--r-- 1,175 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# resumer

Return a through stream that starts out paused and resumes on the next tick,
unless somebody called `.pause()`.

This module has the same signature as
[through](https://npmjs.com/package/through).

[![browser support](https://ci.testling.com/substack/resumer.png)](http://ci.testling.com/substack/resumer)

[![build status](https://secure.travis-ci.org/substack/resumer.png)](http://travis-ci.org/substack/resumer)

# example

``` js
var resumer = require('resumer');
var s = createStream();
s.pipe(process.stdout);

function createStream () {
    var stream = resumer();
    stream.queue('beep boop\n');
    return stream;
}
```

```
$ node example/resume.js
beep boop
```

# methods

``` js
var resumer = require('resumer')
```

## resumer(write, end)

Return a new through stream from `write` and `end`, which default to
pass-through `.queue()` functions if not specified.

The stream starts out paused and will be resumed on the next tick unless you
call `.pause()` first.

`write` and `end` get passed directly through to
[through](https://npmjs.com/package/through).

# install

With [npm](https://npmjs.org) do:

```
npm install resumer
```

# license

MIT