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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
{{alias}}( iterator[, options] )
Creates a readable stream from an iterator.
In object mode, `null` is a reserved value. If an iterator generates `null`
values (e.g., as a means to encode missing values), the stream will
prematurely end. Consider an alternative encoding or explicitly map `null`
values to a different value by wrapping the provided iterator with another
iterator.
In binary mode, if an iterator generates `undefined` values, the stream will
emit an error. Consider providing a custom serialization function or
explicitly map `undefined` values to a different value by wrapping the
provided iterator with another iterator.
If a serialization function fails to return a string or Buffer, the stream
emits an error.
Parameters
----------
iterator: Object
Source iterator.
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before pausing iteration.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.serialize: Function (optional)
Serialization function. The default behavior is to serialize iterated
values as JSON strings. This option is only applicable when a stream is
not in "objectMode".
Returns
-------
stream: ReadableStream
Readable stream.
Examples
--------
> function fcn( chunk ) { console.log( chunk.toString() ); };
> var opts = { 'iter': 10 };
> var it = {{alias:@stdlib/random/iter/randu}}( opts );
> var s = {{alias}}( it );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}( fcn );
> s.pipe( o );
{{alias}}.factory( [options] )
Returns a function for creating readable streams from iterators.
Parameters
----------
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before pausing iteration.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.serialize: Function (optional)
Serialization function. The default behavior is to serialize iterated
values as JSON strings. This option is only applicable when a stream is
not in "objectMode".
Returns
-------
fcn: Function
Function for creating readable streams.
Examples
--------
> var opts = { 'objectMode': true, 'highWaterMark': 64 };
> var createStream = {{alias}}.factory( opts );
{{alias}}.objectMode( iterator[, options] )
Returns an "objectMode" readable stream from an iterator.
In object mode, `null` is a reserved value. If an iterator generates `null`
values (e.g., as a means to encode missing values), the stream will
prematurely end. Consider an alternative encoding or explicitly map `null`
values to a different value by wrapping the provided iterator with another
iterator.
Parameters
----------
iterator: Object
Source iterator.
options: Object (optional)
Options.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of objects to store in an internal buffer
before pausing iteration.
Returns
-------
stream: ReadableStream
Readable stream operating in "objectMode".
Examples
--------
> function fcn( v ) { console.log( v ); };
> var opts = { 'iter': 10 };
> var it = {{alias:@stdlib/random/iter/randu}}( opts );
> var s = {{alias}}.objectMode( it );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}.objectMode( fcn );
> s.pipe( o );
See Also
--------
|
