deno.land / std@0.166.0 / node / _readline.d.ts

_readline.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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// deno-lint-ignore-file no-explicit-any
// Forked from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/cd61f5b4d3d143108569ec3f88adc0eb34b961c4/types/node/readline.d.ts
import { Abortable, EventEmitter } from "./_events.d.ts";import * as promises from "./readline/promises.ts";import { ReadableStream, WritableStream } from "./_global.d.ts";import { Buffer } from "./buffer.ts";import type { AsyncCompleter, Completer, CompleterResult, ReadLineOptions,} from "./_readline_shared_types.d.ts";
/** * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time. * * To use the promise-based APIs: * * ```js * import * as readline from 'node:readline/promises'; * ``` * * To use the callback and sync APIs: * * ```js * import * as readline from 'node:readline'; * ``` * * The following simple example illustrates the basic use of the `readline` module. * * ```js * import * as readline from 'node:readline/promises'; * import { stdin as input, stdout as output } from 'node:process'; * * const rl = readline.createInterface({ input, output }); * * const answer = await rl.question('What do you think of Node.js? '); * * console.log(`Thank you for your valuable feedback: ${answer}`); * * rl.close(); * ``` * * Once this code is invoked, the Node.js application will not terminate until the`readline.Interface` is closed because the interface waits for data to be * received on the `input` stream. * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline.js) */export { promises };export interface Key { sequence?: string | undefined; name?: string | undefined; ctrl?: boolean | undefined; meta?: boolean | undefined; shift?: boolean | undefined;}/** * Instances of the `readline.Interface` class are constructed using the`readline.createInterface()` method. Every instance is associated with a * single `input` `Readable` stream and a single `output` `Writable` stream. * The `output` stream is used to print prompts for user input that arrives on, * and is read from, the `input` stream. * @since v0.1.104 */export class Interface extends EventEmitter { readonly terminal: boolean; /** * The current input data being processed by node. * * This can be used when collecting input from a TTY stream to retrieve the * current value that has been processed thus far, prior to the `line` event * being emitted. Once the `line` event has been emitted, this property will * be an empty string. * * Be aware that modifying the value during the instance runtime may have * unintended consequences if `rl.cursor` is not also controlled. * * **If not using a TTY stream for input, use the `'line'` event.** * * One possible use case would be as follows: * * ```js * const values = ['lorem ipsum', 'dolor sit amet']; * const rl = readline.createInterface(process.stdin); * const showResults = debounce(() => { * console.log( * '\n', * values.filter((val) => val.startsWith(rl.line)).join(' ') * ); * }, 300); * process.stdin.on('keypress', (c, k) => { * showResults(); * }); * ``` * @since v0.1.98 */ readonly line: string; /** * The cursor position relative to `rl.line`. * * This will track where the current cursor lands in the input string, when * reading input from a TTY stream. The position of cursor determines the * portion of the input string that will be modified as input is processed, * as well as the column where the terminal caret will be rendered. * @since v0.1.98 */ readonly cursor: number; /** * NOTE: According to the documentation: * * > Instances of the `readline.Interface` class are constructed using the * > `readline.createInterface()` method. * * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface */ protected constructor( input: ReadableStream, output?: WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean, ); /** * NOTE: According to the documentation: * * > Instances of the `readline.Interface` class are constructed using the * > `readline.createInterface()` method. * * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface */ protected constructor(options: ReadLineOptions); /** * The `rl.getPrompt()` method returns the current prompt used by `rl.prompt()`. * @since v15.3.0 * @return the current prompt string */ getPrompt(): string; /** * The `rl.setPrompt()` method sets the prompt that will be written to `output`whenever `rl.prompt()` is called. * @since v0.1.98 */ setPrompt(prompt: string): void; /** * The `rl.prompt()` method writes the `readline.Interface` instances configured`prompt` to a new line in `output` in order to provide a user with a new * location at which to provide input. * * When called, `rl.prompt()` will resume the `input` stream if it has been * paused. * * If the `readline.Interface` was created with `output` set to `null` or`undefined` the prompt is not written. * @since v0.1.98 * @param preserveCursor If `true`, prevents the cursor placement from being reset to `0`. */ prompt(preserveCursor?: boolean): void; /** * The `rl.question()` method displays the `query` by writing it to the `output`, * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument. * * When called, `rl.question()` will resume the `input` stream if it has been * paused. * * If the `readline.Interface` was created with `output` set to `null` or`undefined` the `query` is not written. * * The `callback` function passed to `rl.question()` does not follow the typical * pattern of accepting an `Error` object or `null` as the first argument. * The `callback` is called with the provided answer as the only argument. * * Example usage: * * ```js * rl.question('What is your favorite food? ', (answer) => { * console.log(`Oh, so your favorite food is ${answer}`); * }); * ``` * * Using an `AbortController` to cancel a question. * * ```js * const ac = new AbortController(); * const signal = ac.signal; * * rl.question('What is your favorite food? ', { signal }, (answer) => { * console.log(`Oh, so your favorite food is ${answer}`); * }); * * signal.addEventListener('abort', () => { * console.log('The food question timed out'); * }, { once: true }); * * setTimeout(() => ac.abort(), 10000); * ``` * * If this method is invoked as it's util.promisify()ed version, it returns a * Promise that fulfills with the answer. If the question is canceled using * an `AbortController` it will reject with an `AbortError`. * * ```js * const util = require('util'); * const question = util.promisify(rl.question).bind(rl); * * async function questionExample() { * try { * const answer = await question('What is you favorite food? '); * console.log(`Oh, so your favorite food is ${answer}`); * } catch (err) { * console.error('Question rejected', err); * } * } * questionExample(); * ``` * @since v0.3.3 * @param query A statement or query to write to `output`, prepended to the prompt. * @param callback A callback function that is invoked with the user's input in response to the `query`. */ question(query: string, callback: (answer: string) => void): void; question( query: string, options: Abortable, callback: (answer: string) => void, ): void; /** * The `rl.pause()` method pauses the `input` stream, allowing it to be resumed * later if necessary. * * Calling `rl.pause()` does not immediately pause other events (including`'line'`) from being emitted by the `readline.Interface` instance. * @since v0.3.4 */ pause(): this; /** * The `rl.resume()` method resumes the `input` stream if it has been paused. * @since v0.3.4 */ resume(): this; /** * The `rl.close()` method closes the `readline.Interface` instance and * relinquishes control over the `input` and `output` streams. When called, * the `'close'` event will be emitted. * * Calling `rl.close()` does not immediately stop other events (including `'line'`) * from being emitted by the `readline.Interface` instance. * @since v0.1.98 */ close(): void; /** * The `rl.write()` method will write either `data` or a key sequence identified * by `key` to the `output`. The `key` argument is supported only if `output` is * a `TTY` text terminal. See `TTY keybindings` for a list of key * combinations. * * If `key` is specified, `data` is ignored. * * When called, `rl.write()` will resume the `input` stream if it has been * paused. * * If the `readline.Interface` was created with `output` set to `null` or`undefined` the `data` and `key` are not written. * * ```js * rl.write('Delete this!'); * // Simulate Ctrl+U to delete the line written previously * rl.write(null, { ctrl: true, name: 'u' }); * ``` * * The `rl.write()` method will write the data to the `readline` `Interface`'s`input`_as if it were provided by the user_. * @since v0.1.98 */ write(data: string | Buffer, key?: Key): void; write(data: undefined | null | string | Buffer, key: Key): void; /** * Returns the real position of the cursor in relation to the input * prompt + string. Long input (wrapping) strings, as well as multiple * line prompts are included in the calculations. * @since v13.5.0, v12.16.0 */ getCursorPos(): CursorPos; /** * events.EventEmitter * 1. close * 2. line * 3. pause * 4. resume * 5. SIGCONT * 6. SIGINT * 7. SIGTSTP * 8. history */ addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "close", listener: () => void): this; addListener(event: "line", listener: (input: string) => void): this; addListener(event: "pause", listener: () => void): this; addListener(event: "resume", listener: () => void): this; addListener(event: "SIGCONT", listener: () => void): this; addListener(event: "SIGINT", listener: () => void): this; addListener(event: "SIGTSTP", listener: () => void): this; addListener(event: "history", listener: (history: string[]) => void): this; emit(event: string | symbol, ...args: any[]): boolean; emit(event: "close"): boolean; emit(event: "line", input: string): boolean; emit(event: "pause"): boolean; emit(event: "resume"): boolean; emit(event: "SIGCONT"): boolean; emit(event: "SIGINT"): boolean; emit(event: "SIGTSTP"): boolean; emit(event: "history", history: string[]): boolean; on(event: string, listener: (...args: any[]) => void): this; on(event: "close", listener: () => void): this; on(event: "line", listener: (input: string) => void): this; on(event: "pause", listener: () => void): this; on(event: "resume", listener: () => void): this; on(event: "SIGCONT", listener: () => void): this; on(event: "SIGINT", listener: () => void): this; on(event: "SIGTSTP", listener: () => void): this; on(event: "history", listener: (history: string[]) => void): this; once(event: string, listener: (...args: any[]) => void): this; once(event: "close", listener: () => void): this; once(event: "line", listener: (input: string) => void): this; once(event: "pause", listener: () => void): this; once(event: "resume", listener: () => void): this; once(event: "SIGCONT", listener: () => void): this; once(event: "SIGINT", listener: () => void): this; once(event: "SIGTSTP", listener: () => void): this; once(event: "history", listener: (history: string[]) => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: () => void): this; prependListener(event: "line", listener: (input: string) => void): this; prependListener(event: "pause", listener: () => void): this; prependListener(event: "resume", listener: () => void): this; prependListener(event: "SIGCONT", listener: () => void): this; prependListener(event: "SIGINT", listener: () => void): this; prependListener(event: "SIGTSTP", listener: () => void): this; prependListener( event: "history", listener: (history: string[]) => void, ): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; prependOnceListener(event: "close", listener: () => void): this; prependOnceListener(event: "line", listener: (input: string) => void): this; prependOnceListener(event: "pause", listener: () => void): this; prependOnceListener(event: "resume", listener: () => void): this; prependOnceListener(event: "SIGCONT", listener: () => void): this; prependOnceListener(event: "SIGINT", listener: () => void): this; prependOnceListener(event: "SIGTSTP", listener: () => void): this; prependOnceListener( event: "history", listener: (history: string[]) => void, ): this; [Symbol.asyncIterator](): AsyncIterableIterator<string>;}export type ReadLine = Interface; // type forwarded for backwards compatibilityexport { AsyncCompleter, Completer, CompleterResult, ReadLineOptions };/** * The `readline.createInterface()` method creates a new `readline.Interface`instance. * * ```js * const readline = require('readline'); * const rl = readline.createInterface({ * input: process.stdin, * output: process.stdout * }); * ``` * * Once the `readline.Interface` instance is created, the most common case is to * listen for the `'line'` event: * * ```js * rl.on('line', (line) => { * console.log(`Received: ${line}`); * }); * ``` * * If `terminal` is `true` for this instance then the `output` stream will get * the best compatibility if it defines an `output.columns` property and emits * a `'resize'` event on the `output` if or when the columns ever change * (`process.stdout` does this automatically when it is a TTY). * * When creating a `readline.Interface` using `stdin` as input, the program * will not terminate until it receives `EOF` (Ctrl+D on * Linux/macOS, Ctrl+Z followed by Return on * Windows). * If you want your application to exit without waiting for user input, you can `unref()` the standard input stream: * * ```js * process.stdin.unref(); * ``` * @since v0.1.98 */export function createInterface( input: ReadableStream, output?: WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean,): Interface;export function createInterface(options: ReadLineOptions): Interface;/** * The `readline.emitKeypressEvents()` method causes the given `Readable` stream to begin emitting `'keypress'` events corresponding to received input. * * Optionally, `interface` specifies a `readline.Interface` instance for which * autocompletion is disabled when copy-pasted input is detected. * * If the `stream` is a `TTY`, then it must be in raw mode. * * This is automatically called by any readline instance on its `input` if the`input` is a terminal. Closing the `readline` instance does not stop * the `input` from emitting `'keypress'` events. * * ```js * readline.emitKeypressEvents(process.stdin); * if (process.stdin.isTTY) * process.stdin.setRawMode(true); * ``` * * ## Example: Tiny CLI * * The following example illustrates the use of `readline.Interface` class to * implement a small command-line interface: * * ```js * const readline = require('readline'); * const rl = readline.createInterface({ * input: process.stdin, * output: process.stdout, * prompt: 'OHAI> ' * }); * * rl.prompt(); * * rl.on('line', (line) => { * switch (line.trim()) { * case 'hello': * console.log('world!'); * break; * default: * console.log(`Say what? I might have heard '${line.trim()}'`); * break; * } * rl.prompt(); * }).on('close', () => { * console.log('Have a great day!'); * process.exit(0); * }); * ``` * * ## Example: Read file stream line-by-Line * * A common use case for `readline` is to consume an input file one line at a * time. The easiest way to do so is leveraging the `fs.ReadStream` API as * well as a `for await...of` loop: * * ```js * const fs = require('fs'); * const readline = require('readline'); * * async function processLineByLine() { * const fileStream = fs.createReadStream('input.txt'); * * const rl = readline.createInterface({ * input: fileStream, * crlfDelay: Infinity * }); * // Note: we use the crlfDelay option to recognize all instances of CR LF * // ('\r\n') in input.txt as a single line break. * * for await (const line of rl) { * // Each line in input.txt will be successively available here as `line`. * console.log(`Line from file: ${line}`); * } * } * * processLineByLine(); * ``` * * Alternatively, one could use the `'line'` event: * * ```js * const fs = require('fs'); * const readline = require('readline'); * * const rl = readline.createInterface({ * input: fs.createReadStream('sample.txt'), * crlfDelay: Infinity * }); * * rl.on('line', (line) => { * console.log(`Line from file: ${line}`); * }); * ``` * * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied: * * ```js * const { once } = require('events'); * const { createReadStream } = require('fs'); * const { createInterface } = require('readline'); * * (async function processLineByLine() { * try { * const rl = createInterface({ * input: createReadStream('big-file.txt'), * crlfDelay: Infinity * }); * * rl.on('line', (line) => { * // Process the line. * }); * * await once(rl, 'close'); * * console.log('File processed.'); * } catch (err) { * console.error(err); * } * })(); * ``` * @since v0.7.7 */export function emitKeypressEvents( stream: ReadableStream, readlineInterface?: Interface,): void;export type Direction = -1 | 0 | 1;export interface CursorPos { rows: number; cols: number;}/** * The `readline.clearLine()` method clears current line of given `TTY` stream * in a specified direction identified by `dir`. * @since v0.7.7 * @param callback Invoked once the operation completes. * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. */export function clearLine( stream: WritableStream, dir: Direction, callback?: () => void,): boolean;/** * The `readline.clearScreenDown()` method clears the given `TTY` stream from * the current position of the cursor down. * @since v0.7.7 * @param callback Invoked once the operation completes. * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. */export function clearScreenDown( stream: WritableStream, callback?: () => void,): boolean;/** * The `readline.cursorTo()` method moves cursor to the specified position in a * given `TTY` `stream`. * @since v0.7.7 * @param callback Invoked once the operation completes. * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. */export function cursorTo( stream: WritableStream, x: number, y?: number, callback?: () => void,): boolean;/** * The `readline.moveCursor()` method moves the cursor _relative_ to its current * position in a given `TTY` `stream`. * * ## Example: Tiny CLI * * The following example illustrates the use of `readline.Interface` class to * implement a small command-line interface: * * ```js * const readline = require('readline'); * const rl = readline.createInterface({ * input: process.stdin, * output: process.stdout, * prompt: 'OHAI> ' * }); * * rl.prompt(); * * rl.on('line', (line) => { * switch (line.trim()) { * case 'hello': * console.log('world!'); * break; * default: * console.log(`Say what? I might have heard '${line.trim()}'`); * break; * } * rl.prompt(); * }).on('close', () => { * console.log('Have a great day!'); * process.exit(0); * }); * ``` * * ## Example: Read file stream line-by-Line * * A common use case for `readline` is to consume an input file one line at a * time. The easiest way to do so is leveraging the `fs.ReadStream` API as * well as a `for await...of` loop: * * ```js * const fs = require('fs'); * const readline = require('readline'); * * async function processLineByLine() { * const fileStream = fs.createReadStream('input.txt'); * * const rl = readline.createInterface({ * input: fileStream, * crlfDelay: Infinity * }); * // Note: we use the crlfDelay option to recognize all instances of CR LF * // ('\r\n') in input.txt as a single line break. * * for await (const line of rl) { * // Each line in input.txt will be successively available here as `line`. * console.log(`Line from file: ${line}`); * } * } * * processLineByLine(); * ``` * * Alternatively, one could use the `'line'` event: * * ```js * const fs = require('fs'); * const readline = require('readline'); * * const rl = readline.createInterface({ * input: fs.createReadStream('sample.txt'), * crlfDelay: Infinity * }); * * rl.on('line', (line) => { * console.log(`Line from file: ${line}`); * }); * ``` * * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied: * * ```js * const { once } = require('events'); * const { createReadStream } = require('fs'); * const { createInterface } = require('readline'); * * (async function processLineByLine() { * try { * const rl = createInterface({ * input: createReadStream('big-file.txt'), * crlfDelay: Infinity * }); * * rl.on('line', (line) => { * // Process the line. * }); * * await once(rl, 'close'); * * console.log('File processed.'); * } catch (err) { * console.error(err); * } * })(); * ``` * @since v0.7.7 * @param callback Invoked once the operation completes. * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. */export function moveCursor( stream: WritableStream, dx: number, dy: number, callback?: () => void,): boolean;
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2447

Version Info

Tagged at
2 months ago