/
index.d.ts
421 lines (394 loc) · 12.2 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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/// <reference types="node" />
import { Writable, Readable } from "stream";
type GlobalLimit = number;
type LocalLimit = number;
interface BasicInfrequentReplaceOption {
/**
* Perform a full replacement or not.
*
* A RegExp search without capture groups or a search in string will be
* treated as a full replacement silently.
*/
isFullReplacement?: Boolean;
/**
* Only valid for a string replacement.
*
* Disable placeholders in replacement or not. Processed result shall be
* exactly the same as the string replacement if set to true.
*
* Default: false
*/
disablePlaceholders?: Boolean;
/**
* Apply restriction on certain search's maximum executed times.
*
* Upon reaching the limit, if option `truncate` is falsy (false by default),
* underlying transform stream will become a transparent passThrough stream.
*
* Default: Infinity. 0 is considered as Infinity for this option.
*/
limit?: LocalLimit;
/**
* Observe a certain search's executed times, remove that search right
* after upper limit reached.
*
* Default: Infinity. 0 is considered as Infinity for this option.
*/
maxTimes?: number;
/**
* For the search you specified, add a limit below which the substitution
* is considered failed.
*/
minTimes?: number;
/**
* Sugar for minTimes = 1
*/
required?: boolean;
}
interface BasicReplaceOption extends BasicInfrequentReplaceOption {
/**
* Correspondence: String.prototype.replace's 2nd argument.
*
* Replaces the according text for a given match, a string or
* a function that returns the replacement text can be passed.
*
* Special replacement patterns (parenthesized capture group placeholders)
* / async replacement functions are well supported.
*
* For a partial replacement, $& (also the 1st supplied value to replace
* function) and $1 (the 2nd param passed) always have the same value,
* supplying the matched substring in the parenthesized capture group
* you specified.
*/
replacement?:
string | ((wholeMatch: string, ...args: string[]) => string)
| ((wholeMatch: string, ...args: string[]) => Promise<string>)
}
interface SearchAndReplaceOption extends BasicReplaceOption {
/**
* Correspondence: `String.prototype.replaceAll`'s 1st argument.
*
* Accepts a literal string or a RegExp object.
*
* Will replace all occurrences by converting input into a global RegExp
* object, which means that the according replacement might be invoked
* multiple times for each full match to be replaced.
*
* Every `search` and `replacement` not arranged in pairs is silently
* discarded in `options`, while in `options.replace` that will result in
* an error thrown.
*/
search?: string | RegExp;
}
interface MatchAndReplaceOption extends BasicReplaceOption {
/**
* Alias for options.search.
*
* Correspondence: `String.prototype.replaceAll`'s 1st argument.
*
* Accepts a literal string or a RegExp object.
*
* Will replace all occurrences by converting input into a global RegExp
* object, which means that the according replacement might be invoked
* multiple times for each full match to be replaced.
*
* Every `match` and `replacement` not arranged in pairs is silently
* discarded in `options`, while in `options.replace` that will result in
* an error thrown.
*/
match?: string | RegExp;
}
interface MultipleReplacementOption {
/**
* Apply restriction on the maximum count of every search's executed times.
*
* Upon reaching the limit, if option `truncate` is falsy (false by default),
* underlying transform stream will become a transparent passThrough stream.
*
* Default: Infinity. 0 is considered as Infinity for this option.
*/
limit?: GlobalLimit;
/**
* Should be an array of { [ "match" | "search" ], "replacement" } pairs.
*
* Possible `search|match` and `replacement` pair in `options` scope will be
* prepended to `options.replace` array, if both exist.
*/
replace?: Array<SearchAndReplaceOption | MatchAndReplaceOption>;
/**
* Default: {}
*/
defaultOptions?: BasicInfrequentReplaceOption;
}
// An interface can only extend an object type or intersection of object types with statically known members.
type ReplaceOptions = MultipleReplacementOption & MatchAndReplaceOption & SearchAndReplaceOption;
interface BasicOptions extends ReplaceOptions {
/**
* Correspondence: String.prototype.split's 1nd argument.
*
* Accepts a literal string or a RegExp object.
*
* Used by underlying transform stream to split upstream data into separate
* to-be-processed parts.
*
* String.prototype.split will implicitly call `toString` on non-string &
* non-regex & non-void values.
*
* Specify `null` or `undefined` to process upstream data as a whole.
*
* Default: /(?<=\r?\n)/. Line endings following lines.
*/
separator?: string | RegExp | null;
/**
* Correspondence: String.prototype.join's 1nd argument, though a function
* is also acceptable.
*
* You can specify a literal string or a function that returns the post-processed
* part.
*
* Example function for appending a CRLF: part => part.concat("\r\n");
*
* Default: part => part
*/
join?: string | ((part: string) => string) | null;
/**
* Correspondence: encoding of Node.js Buffer.
*
* If specified, then processed and joined strings will be encoded to buffers
* with that encoding.
*
* Node.js currently supportes following options:
* "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"
* Default: null.
*/
encoding?: BufferEncoding | null;
/**
* Correspondence: encodings of WHATWG Encoding Standard TextDecoder.
*
* Accept a specific character encoding, like utf-8, iso-8859-2, koi8, cp1261,
* gbk, etc for decoding the input raw buffer.
*
* This option only makes sense when no encoding is assigned and stream data are
* passed as Buffer objects (that is, haven't done something like
* readable.setEncoding('utf8'));
*
* Example: streamEdit({
* from: createReadStream("gbk.txt"),
* to: createWriteStream("utf8.txt"),
* decodeBuffers: "gbk"
* });
*
* Some encodings are only available for Node embedded the entire ICU (full-icu).
* See https://nodejs.org/api/util.html#util_class_util_textdecoder.
*
* Default: "utf8".
*/
decodeBuffers?: string;
/**
* Truncating the rest or not when limits reached.
*
* Default: false.
*/
truncate?: Boolean;
/**
* The maximum size of the line buffer.
*
* A line buffer is the buffer used for buffering the last incomplete substring
* when dividing chunks (typically 64 KiB) by options.separator.
*
* Default: Infinity.
*/
maxLength?: number;
/**
* Correspondence: readableObjectMode option of Node.js stream.Transform
*
* Options writableObjectMode and objectMode are not supported.
*
* Default: Infinity.
*/
readableObjectMode?: boolean;
/**
* An optional controller object that allows you to abort one or more
* substitutions as and when desired.
*
* Node version >= 15.0.0 is required.
*/
abortController?: AbortController;
/**
* A post-processing function that consumes transformed strings and returns a
* string or a Buffer. This option has higher priority over option `join`.
*
* If readableObjectMode is enabled, any object accepted by Node.js objectMode
* streams can be returned.
*/
postProcessing?: (part: string, isLastPart: boolean) => any;
/**
* This optional function will be called before the destination(s) close,
* delaying the resolution of the promise returned by streamEdit() until
* beforeCompletion resolves.
*
* You can also return a rejected promise or simply raise an error to signal a
* failure and destroy all streams.
*/
beforeCompletion?: () => Promise<void> | void;
}
type WritableOrVoid = Writable | void;
// streamEdit - file
interface UpdateFileOptions extends BasicOptions {
/**
* Path to the file.
*/
file: string;
/**
* Correspondence: fs.read's 4th argument - position
*
* The location where to begin reading data from the file.
*
* Default: 0
*/
readStart?: number;
/**
* Correspondence: fs.write's 4th argument - position
*
* The offset from the beginning of the file where the substituted data should be written.
*
* writeStart should be smaller or equal to readStart.
*
* Default: 0
*/
writeStart?: number;
}
// streamEdit - TransformReadable
interface TransformReadableOptions<T> extends BasicOptions {
/**
* A Readable stream.
*/
from: Readable;
/**
* A Writable stream.
*/
to: T;
}
interface TransformReadableOptionsAlias<T> extends BasicOptions {
/**
* Alias of `from`.
*/
readableStream: Readable;
/**
* Alias of `to`.
*/
writableStream: T;
}
// streamEdit - files
interface UpdateFilesOptions extends BasicOptions {
/**
* A array of filepaths.
*/
files: string[];
/**
* Correspondence: fs.read's 4th argument - position
*
* The location where to begin reading data from the file.
*
* Applies to all files.
*
* Default: 0
*/
readStart?: number;
/**
* Correspondence: fs.write's 4th argument - position
*
* The offset from the beginning of the file where the substituted data should be written.
*
* Applies to all files.
*
* writeStart should be smaller or equal to readStart.
*
* Default: 0
*/
writeStart?: number;
}
// streamEdit - readables -> writable
interface MultipleReadablesToWritableOptions<T> extends BasicOptions {
/**
* An array of Readable streams.
*/
from: Array<Readable>;
/**
* A Writable stream.
*/
to: T;
/**
* Concatenate results of transformed Readables with the input value.
*
* Accepts a literal string or a Buffer.
*
* Default: ""
*/
contentJoin: string | Buffer;
}
interface MultipleReadablesToWritableOptionsAlias<T> extends BasicOptions {
/**
* Alias of `from`.
* An array of Readable streams
*/
readableStreams: Array<Readable>;
/**
* Alias of `to`.
* A Writable stream.
*/
writableStream: T;
/**
* Concatenate results of transformed Readables with the input value.
*
* Accepts a literal string or a Buffer.
*
* option.encoding will be passed along with contentJoin to Writable.write
*
* Default: ""
*/
contentJoin: string | Buffer;
}
// streamEdit - readable -> writables
interface ReadableToMultipleWritablesOptions<T> extends BasicOptions {
/**
* A Readable stream source.
*/
from: Readable;
/**
* An array of Writable streams, preferably being the same type.
*/
to: Array<T>;
}
interface ReadableToMultipleWritablesOptionsAlias<T> extends BasicOptions {
/**
* Alias of `from`.
* A Readable stream source.
*/
readableStream: Readable;
/**
* Alias of `to`.
* An array of Writable streams, preferably being the same type.
*/
writableStreams: Array<T>;
}
/**
* update files, or transform streams and pipe/tee/combine them here and there.
*
* `from` `to` cannot be arrays at the same time.
*
* P.S. TS doesn't support overloading functions with same
* number of parameters, so a huge union is there 😀
*/
export declare function streamEdit<T extends WritableOrVoid>(
options:
UpdateFileOptions | TransformReadableOptions<T> | TransformReadableOptionsAlias<T> |
UpdateFilesOptions |
MultipleReadablesToWritableOptionsAlias<T> | MultipleReadablesToWritableOptions<T> |
ReadableToMultipleWritablesOptions<T> | ReadableToMultipleWritablesOptionsAlias<T>
): Promise<T[] | T>;
type StreamEdit = typeof streamEdit;
/**
* Alias for streamEdit
*/
export const sed: StreamEdit;