@types/node 16.11.39 → 18.11.2

node v16.11/readline.d.ts → node/readline.d.ts

@@ -1,36 +1,43 @@
 /**
- * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time. It can be accessed
- * using:
+ * 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
- * const readline = require('readline');
+ * 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
- * const readline = require('readline');
+ * import * as readline from 'node:readline/promises';
+ * import { stdin as input, stdout as output } from 'node:process';
+ *
+ * const rl = readline.createInterface({ input, output });
  *
- * const rl = readline.createInterface({
- *   input: process.stdin,
- *   output: process.stdout
- * });
+ * const answer = await rl.question('What do you think of Node.js? ');
  *
- * rl.question('What do you think of Node.js? ', (answer) => {
- *   // TODO: Log the answer in a database
- *   console.log(`Thank you for your valuable feedback: ${answer}`);
+ * console.log(`Thank you for your valuable feedback: ${answer}`);
  *
- *   rl.close();
- * });
+ * 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/v16.9.0/lib/readline.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline.js)
  */
 declare module 'readline' {
     import { Abortable, EventEmitter } from 'node:events';
-    interface Key {
+    import * as promises from 'node:readline/promises';
+
+    export { promises };
+    export interface Key {
         sequence?: string | undefined;
         name?: string | undefined;
         ctrl?: boolean | undefined;
@@ -44,7 +51,7 @@ declare module 'readline' {
      * and is read from, the `input` stream.
      * @since v0.1.104
      */
-    class Interface extends EventEmitter {
+    export class Interface extends EventEmitter {
         readonly terminal: boolean;
         /**
          * The current input data being processed by node.
@@ -311,11 +318,11 @@ declare module 'readline' {
         prependOnceListener(event: 'history', listener: (history: string[]) => void): this;
         [Symbol.asyncIterator](): AsyncIterableIterator<string>;
     }
-    type ReadLine = Interface; // type forwarded for backwards compatibility
-    type Completer = (line: string) => CompleterResult;
-    type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
-    type CompleterResult = [string[], string];
-    interface ReadLineOptions {
+    export type ReadLine = Interface; // type forwarded for backwards compatibility
+    export type Completer = (line: string) => CompleterResult;
+    export type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
+    export type CompleterResult = [string[], string];
+    export interface ReadLineOptions {
         input: NodeJS.ReadableStream;
         output?: NodeJS.WritableStream | undefined;
         completer?: Completer | AsyncCompleter | undefined;
@@ -376,8 +383,8 @@ declare module 'readline' {
      * ```
      * @since v0.1.98
      */
-    function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;
-    function createInterface(options: ReadLineOptions): Interface;
+    export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.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.
      *
@@ -394,11 +401,114 @@ declare module 'readline' {
      * 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
      */
-    function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
-    type Direction = -1 | 0 | 1;
-    interface CursorPos {
+    export function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
+    export type Direction = -1 | 0 | 1;
+    export interface CursorPos {
         rows: number;
         cols: number;
     }
@@ -409,7 +519,7 @@ declare module 'readline' {
      * @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`.
      */
-    function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
+    export function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
     /**
      * The `readline.clearScreenDown()` method clears the given `TTY` stream from
      * the current position of the cursor down.
@@ -417,7 +527,7 @@ declare module 'readline' {
      * @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`.
      */
-    function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
+    export function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
     /**
      * The `readline.cursorTo()` method moves cursor to the specified position in a
      * given `TTY` `stream`.
@@ -425,7 +535,7 @@ declare module 'readline' {
      * @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`.
      */
-    function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
+    export function cursorTo(stream: NodeJS.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`.
@@ -536,7 +646,7 @@ declare module 'readline' {
      * @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`.
      */
-    function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
+    export function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
 }
 declare module 'node:readline' {
     export * from 'readline';

node v16.11/repl.d.ts → node/repl.d.ts

@@ -6,7 +6,7 @@
  * ```js
  * const repl = require('repl');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/repl.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/repl.js)
  */
 declare module 'repl' {
     import { Interface, Completer, AsyncCompleter } from 'node:readline';
@@ -277,7 +277,7 @@ declare module 'repl' {
          * Goodbye!
          * ```
          * @since v0.3.0
-         * @param keyword The command keyword (*without* a leading `.` character).
+         * @param keyword The command keyword (_without_ a leading `.` character).
          * @param cmd The function to invoke when the command is processed.
          */
         defineCommand(keyword: string, cmd: REPLCommandAction | REPLCommand): void;

node v16.11/stream/consumers.d.ts → node/stream/consumers.d.ts

@@ -1,22 +1,10 @@
-// Duplicates of interface in lib.dom.ts.
-// Duplicated here rather than referencing lib.dom.ts because doing so causes lib.dom.ts to be loaded for "test-all"
-// Which in turn causes tests to pass that shouldn't pass.
-//
-// This interface is not, and should not be, exported.
-interface Blob {
-    readonly size: number;
-    readonly type: string;
-    arrayBuffer(): Promise<ArrayBuffer>;
-    slice(start?: number, end?: number, contentType?: string): Blob;
-    stream(): NodeJS.ReadableStream;
-    text(): Promise<string>;
-}
 declare module 'stream/consumers' {
+    import { Blob as NodeBlob } from "node:buffer";
     import { Readable } from 'node:stream';
     function buffer(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<Buffer>;
     function text(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<string>;
     function arrayBuffer(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<ArrayBuffer>;
-    function blob(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<Blob>;
+    function blob(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<NodeBlob>;
     function json(stream: NodeJS.ReadableStream | Readable | AsyncIterator<any>): Promise<unknown>;
 }
 declare module 'node:stream/consumers' {

node v16.11/stream/web.d.ts → node/stream/web.d.ts

@@ -1,7 +1,6 @@
 declare module 'stream/web' {
     // stub module, pending copy&paste from .d.ts or manual impl
     // copy from lib.dom.d.ts
-
     interface ReadableWritablePair<R = any, W = any> {
         readable: ReadableStream<R>;
         /**
@@ -15,7 +14,6 @@ declare module 'stream/web' {
          */
         writable: WritableStream<W>;
     }
-
     interface StreamPipeOptions {
         preventAbort?: boolean;
         preventCancel?: boolean;
@@ -63,70 +61,53 @@ declare module 'stream/web' {
         preventClose?: boolean;
         signal?: AbortSignal;
     }
-
     interface ReadableStreamGenericReader {
         readonly closed: Promise<undefined>;
         cancel(reason?: any): Promise<void>;
     }
-
     interface ReadableStreamDefaultReadValueResult<T> {
         done: false;
         value: T;
     }
-
     interface ReadableStreamDefaultReadDoneResult {
         done: true;
         value?: undefined;
     }
     type ReadableStreamController<T> = ReadableStreamDefaultController<T>;
-    type ReadableStreamDefaultReadResult<T> =
-        | ReadableStreamDefaultReadValueResult<T>
-        | ReadableStreamDefaultReadDoneResult;
-
+    type ReadableStreamDefaultReadResult<T> = ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult;
     interface ReadableByteStreamControllerCallback {
         (controller: ReadableByteStreamController): void | PromiseLike<void>;
     }
-
     interface UnderlyingSinkAbortCallback {
         (reason?: any): void | PromiseLike<void>;
     }
-
     interface UnderlyingSinkCloseCallback {
         (): void | PromiseLike<void>;
     }
-
     interface UnderlyingSinkStartCallback {
         (controller: WritableStreamDefaultController): any;
     }
-
     interface UnderlyingSinkWriteCallback<W> {
         (chunk: W, controller: WritableStreamDefaultController): void | PromiseLike<void>;
     }
-
     interface UnderlyingSourceCancelCallback {
         (reason?: any): void | PromiseLike<void>;
     }
-
     interface UnderlyingSourcePullCallback<R> {
         (controller: ReadableStreamController<R>): void | PromiseLike<void>;
     }
-
     interface UnderlyingSourceStartCallback<R> {
         (controller: ReadableStreamController<R>): any;
     }
-
     interface TransformerFlushCallback<O> {
         (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
     }
-
     interface TransformerStartCallback<O> {
         (controller: TransformStreamDefaultController<O>): any;
     }
-
     interface TransformerTransformCallback<I, O> {
         (chunk: I, controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
     }
-
     interface UnderlyingByteSource {
         autoAllocateChunkSize?: number;
         cancel?: ReadableStreamErrorCallback;
@@ -134,14 +115,12 @@ declare module 'stream/web' {
         start?: ReadableByteStreamControllerCallback;
         type: 'bytes';
     }
-
     interface UnderlyingSource<R = any> {
         cancel?: UnderlyingSourceCancelCallback;
         pull?: UnderlyingSourcePullCallback<R>;
         start?: UnderlyingSourceStartCallback<R>;
         type?: undefined;
     }
-
     interface UnderlyingSink<W = any> {
         abort?: UnderlyingSinkAbortCallback;
         close?: UnderlyingSinkCloseCallback;
@@ -149,11 +128,9 @@ declare module 'stream/web' {
         type?: undefined;
         write?: UnderlyingSinkWriteCallback<W>;
     }
-
     interface ReadableStreamErrorCallback {
         (reason: any): void | PromiseLike<void>;
     }
-
     /** This Streams API interface represents a readable stream of byte data. */
     interface ReadableStream<R = any> {
         readonly locked: boolean;
@@ -165,29 +142,21 @@ declare module 'stream/web' {
         values(options?: { preventCancel?: boolean }): AsyncIterableIterator<R>;
         [Symbol.asyncIterator](): AsyncIterableIterator<R>;
     }
-
     const ReadableStream: {
         prototype: ReadableStream;
-        new (
-            underlyingSource: UnderlyingByteSource,
-            strategy?: QueuingStrategy<Uint8Array>,
-        ): ReadableStream<Uint8Array>;
+        new (underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>;
         new <R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
     };
-
     interface ReadableStreamDefaultReader<R = any> extends ReadableStreamGenericReader {
         read(): Promise<ReadableStreamDefaultReadResult<R>>;
         releaseLock(): void;
     }
-
     const ReadableStreamDefaultReader: {
         prototype: ReadableStreamDefaultReader;
         new <R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
     };
-
     const ReadableStreamBYOBReader: any;
     const ReadableStreamBYOBRequest: any;
-
     interface ReadableByteStreamController {
         readonly byobRequest: undefined;
         readonly desiredSize: number | null;
@@ -195,24 +164,20 @@ declare module 'stream/web' {
         enqueue(chunk: ArrayBufferView): void;
         error(error?: any): void;
     }
-
     const ReadableByteStreamController: {
         prototype: ReadableByteStreamController;
         new (): ReadableByteStreamController;
     };
-
     interface ReadableStreamDefaultController<R = any> {
         readonly desiredSize: number | null;
         close(): void;
         enqueue(chunk?: R): void;
         error(e?: any): void;
     }
-
     const ReadableStreamDefaultController: {
         prototype: ReadableStreamDefaultController;
         new (): ReadableStreamDefaultController;
     };
-
     interface Transformer<I = any, O = any> {
         flush?: TransformerFlushCallback<O>;
         readableType?: undefined;
@@ -220,33 +185,24 @@ declare module 'stream/web' {
         transform?: TransformerTransformCallback<I, O>;
         writableType?: undefined;
     }
-
     interface TransformStream<I = any, O = any> {
         readonly readable: ReadableStream<O>;
         readonly writable: WritableStream<I>;
     }
-
     const TransformStream: {
         prototype: TransformStream;
-        new <I = any, O = any>(
-            transformer?: Transformer<I, O>,
-            writableStrategy?: QueuingStrategy<I>,
-            readableStrategy?: QueuingStrategy<O>,
-        ): TransformStream<I, O>;
+        new <I = any, O = any>(transformer?: Transformer<I, O>, writableStrategy?: QueuingStrategy<I>, readableStrategy?: QueuingStrategy<O>): TransformStream<I, O>;
     };
-
     interface TransformStreamDefaultController<O = any> {
         readonly desiredSize: number | null;
         enqueue(chunk?: O): void;
         error(reason?: any): void;
         terminate(): void;
     }
-
     const TransformStreamDefaultController: {
         prototype: TransformStreamDefaultController;
         new (): TransformStreamDefaultController;
     };
-
     /**
      * This Streams API interface provides a standard abstraction for writing
      * streaming data to a destination, known as a sink. This object comes with
@@ -258,12 +214,10 @@ declare module 'stream/web' {
         close(): Promise<void>;
         getWriter(): WritableStreamDefaultWriter<W>;
     }
-
     const WritableStream: {
         prototype: WritableStream;
         new <W = any>(underlyingSink?: UnderlyingSink<W>, strategy?: QueuingStrategy<W>): WritableStream<W>;
     };
-
     /**
      * This Streams API interface is the object returned by
      * WritableStream.getWriter() and once created locks the < writer to the
@@ -279,12 +233,10 @@ declare module 'stream/web' {
         releaseLock(): void;
         write(chunk?: W): Promise<void>;
     }
-
     const WritableStreamDefaultWriter: {
         prototype: WritableStreamDefaultWriter;
         new <W = any>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
     };
-
     /**
      * This Streams API interface represents a controller allowing control of a
      * WritableStream's state. When constructing a WritableStream, the
@@ -294,21 +246,17 @@ declare module 'stream/web' {
     interface WritableStreamDefaultController {
         error(e?: any): void;
     }
-
     const WritableStreamDefaultController: {
         prototype: WritableStreamDefaultController;
         new (): WritableStreamDefaultController;
     };
-
     interface QueuingStrategy<T = any> {
         highWaterMark?: number;
         size?: QueuingStrategySize<T>;
     }
-
     interface QueuingStrategySize<T = any> {
         (chunk?: T): number;
     }
-
     interface QueuingStrategyInit {
         /**
          * Creates a new ByteLengthQueuingStrategy with the provided high water
@@ -321,7 +269,6 @@ declare module 'stream/web' {
          */
         highWaterMark: number;
     }
-
     /**
      * This Streams API interface provides a built-in byte length queuing
      * strategy that can be used when constructing streams.
@@ -330,12 +277,10 @@ declare module 'stream/web' {
         readonly highWaterMark: number;
         readonly size: QueuingStrategySize<ArrayBufferView>;
     }
-
     const ByteLengthQueuingStrategy: {
         prototype: ByteLengthQueuingStrategy;
         new (init: QueuingStrategyInit): ByteLengthQueuingStrategy;
     };
-
     /**
      * This Streams API interface provides a built-in byte length queuing
      * strategy that can be used when constructing streams.
@@ -344,12 +289,10 @@ declare module 'stream/web' {
         readonly highWaterMark: number;
         readonly size: QueuingStrategySize;
     }
-
     const CountQueuingStrategy: {
         prototype: CountQueuingStrategy;
         new (init: QueuingStrategyInit): CountQueuingStrategy;
     };
-
     interface TextEncoderStream {
         /** Returns "utf-8". */
         readonly encoding: 'utf-8';
@@ -357,19 +300,15 @@ declare module 'stream/web' {
         readonly writable: WritableStream<string>;
         readonly [Symbol.toStringTag]: string;
     }
-
     const TextEncoderStream: {
         prototype: TextEncoderStream;
         new (): TextEncoderStream;
     };
-
     interface TextDecoderOptions {
         fatal?: boolean;
         ignoreBOM?: boolean;
     }
-
     type BufferSource = ArrayBufferView | ArrayBuffer;
-
     interface TextDecoderStream {
         /** Returns encoding's name, lower cased. */
         readonly encoding: string;
@@ -381,7 +320,6 @@ declare module 'stream/web' {
         readonly writable: WritableStream<BufferSource>;
         readonly [Symbol.toStringTag]: string;
     }
-
     const TextDecoderStream: {
         prototype: TextDecoderStream;
         new (label?: string, options?: TextDecoderOptions): TextDecoderStream;