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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
{{alias}}( [options,] clbk )
Returns a writable stream for inspecting stream data.
Parameters
----------
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to push downstream.
options.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
clbk: Function
Callback to invoke upon receiving data.
Returns
-------
stream: WritableStream
Writable stream.
Examples
--------
> function clbk( chunk, idx ) { console.log( chunk.toString() ); };
> var s = {{alias}}( clbk );
> s.write( 'a' );
> s.write( 'b' );
> s.write( 'c' );
> s.end();
{{alias}}.factory( [options] )
Returns a function for creating writable streams for inspecting stream data.
Parameters
----------
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to push downstream.
options.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
Returns
-------
createStream( clbk ): Function
Function for creating writable streams.
Examples
--------
> var opts = { 'objectMode': true, 'highWaterMark': 64 };
> var createStream = {{alias}}.factory( opts );
> function clbk( chunk, idx ) { console.log( chunk.toString() ); };
> var s = createStream( clbk );
> s.write( 'a' );
> s.write( 'b' );
> s.write( 'c' );
> s.end();
{{alias}}.objectMode( [options,] clbk )
Returns an "objectMode" writable stream for inspecting stream data.
Parameters
----------
options: Object (optional)
Options.
options.highWaterMark: integer (optional)
Specifies the maximum number of objects to store in an internal buffer
before ceasing to push downstream.
options.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
clbk: Function
Callback to invoke upon receiving data.
Returns
-------
stream: WritableStream
Writable stream operating in "objectMode".
Examples
--------
> function clbk( chunk, idx ) { console.log( chunk.toString() ); };
> var s = {{alias}}.objectMode( clbk );
> s.write( { 'value': 'a' } );
> s.write( { 'value': 'b' } );
> s.write( { 'value': 'c' } );
> s.end();
See Also
--------
|
