-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
207 lines (190 loc) · 6.08 KB
/
index.d.ts
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="node"/>
import { Transform } from 'stream';
/**
* Interface defining stream options.
*/
interface Options {
/**
* Specifies whether a stream should operate in object mode (default: `false`).
*/
objectMode?: boolean;
/**
* Specifies how `Buffer` objects should be decoded to strings (default: `null`).
*/
encoding?: string | null;
/**
* Specifies the `Buffer` level for when `write()` starts returning `false`.
*/
highWaterMark?: number;
/**
* Separator used to join streamed data (default: `/\r?\n/`).
*/
sep?: string | RegExp;
/**
* Specifies whether the stream should remain open even if one side ends (default: `false`).
*/
allowHalfOpen?: boolean;
/**
* Specifies whether the readable side should be in object mode (default: `false`).
*/
readableObjectMode?: boolean;
}
/**
* Interface defining a stream constructor which is both "newable" and "callable".
*/
interface Constructor {
/**
* Split stream constructor.
*
* @param options - stream options
* @param options.sep - separator used to split streamed data (default: /\r?\n/)
* @param options.objectMode - specifies whether a stream should operate in object mode (default: false)
* @param options.encoding - specifies how `Buffer` objects should be decoded to `strings` (default: null)
* @param options.highWaterMark - specifies the `Buffer` level for when `write()` starts returning `false`
* @param options.allowHalfOpen - specifies whether the stream should remain open even if one side ends (default: false)
* @param options.writableObjectMode - specifies whether the writable side should be in object mode (default: false)
* @returns split stream
*
* @example
* var SplitStream = splitStream;
* var stream = new SplitStream();
*
* stream.write( '1\n2\n3' );
* stream.end();
*/
new( options?: Options ): Transform; // newable
/**
* Split stream constructor.
*
* @param options - stream options
* @param options.sep - separator used to split streamed data (default: /\r?\n/)
* @param options.objectMode - specifies whether a stream should operate in object mode (default: false)
* @param options.encoding - specifies how `Buffer` objects should be decoded to `strings` (default: null)
* @param options.highWaterMark - specifies the `Buffer` level for when `write()` starts returning `false`
* @param options.allowHalfOpen - specifies whether the stream should remain open even if one side ends (default: false)
* @param options.writableObjectMode - specifies whether the writable side should be in object mode (default: false)
* @returns split stream
*
* @example
* var stream = splitStream();
*
* stream.write( '1\n2\n3' );
* stream.end();
*/
( options?: Options ): Transform; // callable
/**
* Creates a reusable stream factory.
*
* @param options - stream options
* @param options.sep - separator used to split streamed data (default: /\r?\n/)
* @param options.objectMode - specifies whether a stream should operate in object mode (default: false)
* @param options.encoding - specifies how `Buffer` objects should be decoded to `strings` (default: null)
* @param options.highWaterMark - specifies the `Buffer` level for when `write()` starts returning `false`
* @param options.allowHalfOpen - specifies whether the stream should remain open even if one side ends (default: false)
* @param options.writableObjectMode - specifies whether the writable side should be in object mode (default: false)
* @returns stream factory
*
* @example
* var opts = {
* 'sep': '\t',
* 'objectMode': true,
* 'encoding': 'utf8'
* };
*
* var factory = splitStream.factory( opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( factory() );
* }
*/
factory( options?: Options ): () => Transform;
/**
* Returns a stream with `objectMode` set to `true`.
*
* @param options - stream options
* @param options.sep - separator used to split streamed data (default: /\r?\n/)
* @param options.encoding - specifies how `Buffer` objects should be decoded to `strings` (default: null)
* @param options.highWaterMark - specifies the `Buffer` level for when `write()` starts returning `false`
* @param options.allowHalfOpen - specifies whether the stream should remain open even if one side ends (default: false)
* @param options.writableObjectMode - specifies whether the writable side should be in object mode (default: false)
* @throws must provide valid options
* @returns split stream
*
* @example
* var stream = splitStream.objectMode({
* 'sep': ','
* });
*
* stream.write( 'a,b,c' );
* stream.end();
*/
objectMode( options?: Options ): Transform;
}
/**
* Returns a split stream.
*
* @param options - stream options
* @throws must provide valid options
* @returns stream instance
*
* @example
* var SplitStream = splitStream;
* var stream = new SplitStream();
*
* stream.write( '1\n2\n3' );
* stream.end();
*
* @example
* var stream = splitStream();
*
* stream.write( '1\n2\n3' );
* stream.end();
*
* @example
* var opts = {
* 'sep': '\t',
* 'objectMode': true,
* 'encoding': 'utf8'
* };
*
* var factory = splitStream.factory( opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( factory() );
* }
*
* @example
* var stream = splitStream.objectMode({
* 'sep': ','
* });
*
* stream.write( 'a,b,c' );
* stream.end();
*/
declare var splitStream: Constructor;
// EXPORTS //
export = splitStream;