@types/node
Advanced tools
Comparing version 22.8.6 to 22.8.7
{ | ||
"name": "@types/node", | ||
"version": "22.8.6", | ||
"version": "22.8.7", | ||
"description": "TypeScript definitions for node", | ||
@@ -223,4 +223,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node", | ||
"peerDependencies": {}, | ||
"typesPublisherContentHash": "b5e95f7873a1811a61b3409c809ee30655d0268d76d767dbe9efc27cb421459f", | ||
"typesPublisherContentHash": "eb4a12d3db7d5c2f973b35f0ccc659d77637fdcdc340900124be3f5602cc29bc", | ||
"typeScriptVersion": "4.8" | ||
} |
@@ -317,25 +317,74 @@ /** | ||
export interface ReadLineOptions { | ||
/** | ||
* The [`Readable`](https://nodejs.org/docs/latest-v22.x/api/stream.html#readable-streams) stream to listen to | ||
*/ | ||
input: NodeJS.ReadableStream; | ||
/** | ||
* The [`Writable`](https://nodejs.org/docs/latest-v22.x/api/stream.html#writable-streams) stream to write readline data to. | ||
*/ | ||
output?: NodeJS.WritableStream | undefined; | ||
/** | ||
* An optional function used for Tab autocompletion. | ||
*/ | ||
completer?: Completer | AsyncCompleter | undefined; | ||
/** | ||
* `true` if the `input` and `output` streams should be treated like a TTY, | ||
* and have ANSI/VT100 escape codes written to it. | ||
* Default: checking `isTTY` on the `output` stream upon instantiation. | ||
*/ | ||
terminal?: boolean | undefined; | ||
/** | ||
* Initial list of history lines. This option makes sense | ||
* only if `terminal` is set to `true` by the user or by an internal `output` | ||
* check, otherwise the history caching mechanism is not initialized at all. | ||
* Initial list of history lines. | ||
* This option makes sense only if `terminal` is set to `true` by the user or by an internal `output` check, | ||
* otherwise the history caching mechanism is not initialized at all. | ||
* @default [] | ||
*/ | ||
history?: string[] | undefined; | ||
/** | ||
* Maximum number of history lines retained. | ||
* To disable the history set this value to `0`. | ||
* This option makes sense only if `terminal` is set to `true` by the user or by an internal `output` check, | ||
* otherwise the history caching mechanism is not initialized at all. | ||
* @default 30 | ||
*/ | ||
historySize?: number | undefined; | ||
/** | ||
* If `true`, when a new input line added to the history list duplicates an older one, | ||
* this removes the older line from the list. | ||
* @default false | ||
*/ | ||
removeHistoryDuplicates?: boolean | undefined; | ||
/** | ||
* The prompt string to use. | ||
* @default "> " | ||
*/ | ||
prompt?: string | undefined; | ||
/** | ||
* If the delay between `\r` and `\n` exceeds `crlfDelay` milliseconds, | ||
* both `\r` and `\n` will be treated as separate end-of-line input. | ||
* `crlfDelay` will be coerced to a number no less than `100`. | ||
* It can be set to `Infinity`, in which case | ||
* `\r` followed by `\n` will always be considered a single newline | ||
* (which may be reasonable for [reading files](https://nodejs.org/docs/latest-v22.x/api/readline.html#example-read-file-stream-line-by-line) with `\r\n` line delimiter). | ||
* @default 100 | ||
*/ | ||
crlfDelay?: number | undefined; | ||
/** | ||
* If `true`, when a new input line added | ||
* to the history list duplicates an older one, this removes the older line | ||
* from the list. | ||
* @default false | ||
* The duration `readline` will wait for a character | ||
* (when reading an ambiguous key sequence in milliseconds | ||
* one that can both form a complete key sequence using the input read so far | ||
* and can take additional input to complete a longer key sequence). | ||
* @default 500 | ||
*/ | ||
removeHistoryDuplicates?: boolean | undefined; | ||
escapeCodeTimeout?: number | undefined; | ||
/** | ||
* The number of spaces a tab is equal to (minimum 1). | ||
* @default 8 | ||
*/ | ||
tabSize?: number | undefined; | ||
/** | ||
* Allows closing the interface using an AbortSignal. | ||
* Aborting the signal will internally call `close` on the interface. | ||
*/ | ||
signal?: AbortSignal | undefined; | ||
} | ||
@@ -342,0 +391,0 @@ /** |
@@ -6,4 +6,9 @@ /** | ||
declare module "readline/promises" { | ||
import { AsyncCompleter, Completer, Direction, Interface as _Interface, ReadLineOptions } from "node:readline"; | ||
import { Abortable } from "node:events"; | ||
import { | ||
CompleterResult, | ||
Direction, | ||
Interface as _Interface, | ||
ReadLineOptions as _ReadLineOptions, | ||
} from "node:readline"; | ||
/** | ||
@@ -115,2 +120,9 @@ * Instances of the `readlinePromises.Interface` class are constructed using the `readlinePromises.createInterface()` method. Every instance is associated with a | ||
} | ||
type Completer = (line: string) => CompleterResult | Promise<CompleterResult>; | ||
interface ReadLineOptions extends Omit<_ReadLineOptions, "completer"> { | ||
/** | ||
* An optional function used for Tab autocompletion. | ||
*/ | ||
completer?: Completer | undefined; | ||
} | ||
/** | ||
@@ -145,3 +157,3 @@ * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance. | ||
output?: NodeJS.WritableStream, | ||
completer?: Completer | AsyncCompleter, | ||
completer?: Completer, | ||
terminal?: boolean, | ||
@@ -148,0 +160,0 @@ ): Interface; |
@@ -11,3 +11,3 @@ # Installation | ||
### Additional Details | ||
* Last updated: Thu, 31 Oct 2024 18:02:52 GMT | ||
* Last updated: Sun, 03 Nov 2024 04:02:17 GMT | ||
* Dependencies: [undici-types](https://npmjs.com/package/undici-types) | ||
@@ -14,0 +14,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
2271926
50265