@types/node 16.18.118 → 16.18.119

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
node v16.18/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v16.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 31 Oct 2024 18:02:52 GMT
11
+ * Last updated: Sun, 03 Nov 2024 04:02:17 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "16.18.118",
3
+ "version": "16.18.119",
4
4
  "description": "TypeScript definitions for node",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -218,6 +218,6 @@
218
218
  "scripts": {},
219
219
  "dependencies": {},
220
220
  "peerDependencies": {},
221
- "typesPublisherContentHash": "89bf8903de3ba398de8f681a07b47774e7bd8cc7ee302ce637d310f2781cf850",
221
+ "typesPublisherContentHash": "80f699aa3bc172183566506bb47edf1370ff04844ecd8bbab8d3bc91b1e53f99",
222
222
  "typeScriptVersion": "4.8"
223
223
  }
@@ -93,7 +93,7 @@ declare module "readline" {
93
93
  * > Instances of the `readline.Interface` class are constructed using the
94
94
  * > `readline.createInterface()` method.
95
95
  *
96
- * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface
96
+ * @see https://nodejs.org/dist/latest-v16.x/docs/api/readline.html#readline_class_interface
97
97
  */
98
98
  protected constructor(
99
99
  input: NodeJS.ReadableStream,
@@ -107,7 +107,7 @@ declare module "readline" {
107
107
  * > Instances of the `readline.Interface` class are constructed using the
108
108
  * > `readline.createInterface()` method.
109
109
  *
110
- * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface
110
+ * @see https://nodejs.org/dist/latest-v16.x/docs/api/readline.html#readline_class_interface
111
111
  */
112
112
  protected constructor(options: ReadLineOptions);
113
113
  /**
@@ -321,32 +321,81 @@ declare module "readline" {
321
321
  type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
322
322
  type CompleterResult = [string[], string];
323
323
  interface ReadLineOptions {
324
+ /**
325
+ * The [`Readable`](https://nodejs.org/docs/latest-v16.x/api/stream.html#readable-streams) stream to listen to
326
+ */
324
327
  input: NodeJS.ReadableStream;
328
+ /**
329
+ * The [`Writable`](https://nodejs.org/docs/latest-v16.x/api/stream.html#writable-streams) stream to write readline data to.
330
+ */
325
331
  output?: NodeJS.WritableStream | undefined;
332
+ /**
333
+ * An optional function used for Tab autocompletion.
334
+ */
326
335
  completer?: Completer | AsyncCompleter | undefined;
336
+ /**
337
+ * `true` if the `input` and `output` streams should be treated like a TTY,
338
+ * and have ANSI/VT100 escape codes written to it.
339
+ * Default: checking `isTTY` on the `output` stream upon instantiation.
340
+ */
327
341
  terminal?: boolean | undefined;
328
342
  /**
329
- * Initial list of history lines. This option makes sense
330
- * only if `terminal` is set to `true` by the user or by an internal `output`
331
- * check, otherwise the history caching mechanism is not initialized at all.
343
+ * Initial list of history lines.
344
+ * This option makes sense only if `terminal` is set to `true` by the user or by an internal `output` check,
345
+ * otherwise the history caching mechanism is not initialized at all.
332
346
  * @default []
333
347
  */
334
348
  history?: string[] | undefined;
349
+ /**
350
+ * Maximum number of history lines retained.
351
+ * To disable the history set this value to `0`.
352
+ * This option makes sense only if `terminal` is set to `true` by the user or by an internal `output` check,
353
+ * otherwise the history caching mechanism is not initialized at all.
354
+ * @default 30
355
+ */
335
356
  historySize?: number | undefined;
336
- prompt?: string | undefined;
337
- crlfDelay?: number | undefined;
338
357
  /**
339
- * If `true`, when a new input line added
340
- * to the history list duplicates an older one, this removes the older line
341
- * from the list.
358
+ * If `true`, when a new input line added to the history list duplicates an older one,
359
+ * this removes the older line from the list.
342
360
  * @default false
343
361
  */
344
362
  removeHistoryDuplicates?: boolean | undefined;
363
+ /**
364
+ * The prompt string to use.
365
+ * @default "> "
366
+ */
367
+ prompt?: string | undefined;
368
+ /**
369
+ * If the delay between `\r` and `\n` exceeds `crlfDelay` milliseconds,
370
+ * both `\r` and `\n` will be treated as separate end-of-line input.
371
+ * `crlfDelay` will be coerced to a number no less than `100`.
372
+ * It can be set to `Infinity`, in which case
373
+ * `\r` followed by `\n` will always be considered a single newline
374
+ * (which may be reasonable for [reading files](https://nodejs.org/docs/latest-v16.x/api/readline.html#example-read-file-stream-line-by-line) with `\r\n` line delimiter).
375
+ * @default 100
376
+ */
377
+ crlfDelay?: number | undefined;
378
+ /**
379
+ * The duration `readline` will wait for a character
380
+ * (when reading an ambiguous key sequence in milliseconds
381
+ * one that can both form a complete key sequence using the input read so far
382
+ * and can take additional input to complete a longer key sequence).
383
+ * @default 500
384
+ */
345
385
  escapeCodeTimeout?: number | undefined;
386
+ /**
387
+ * The number of spaces a tab is equal to (minimum 1).
388
+ * @default 8
389
+ */
346
390
  tabSize?: number | undefined;
391
+ /**
392
+ * Allows closing the interface using an AbortSignal.
393
+ * Aborting the signal will internally call `close` on the interface.
394
+ */
395
+ signal?: AbortSignal | undefined;
347
396
  }
348
397
  /**
349
- * The `readline.createInterface()` method creates a new `readline.Interface`instance.
398
+ * The `readline.createInterface()` method creates a new `readline.Interface` instance.
350
399
  *
351
400
  * ```js
352
401
  * import readline from 'node:readline';