@types/node 20.12.7 → 20.12.9

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.
@@ -6,7 +6,7 @@ declare module "readline/promises" {
6
6
  import { AsyncCompleter, Completer, Direction, Interface as _Interface, ReadLineOptions } from "node:readline";
7
7
  import { Abortable } from "node:events";
8
8
  /**
9
- * Instances of the `readlinePromises.Interface` class are constructed using the`readlinePromises.createInterface()` method. Every instance is associated with a
9
+ * Instances of the `readlinePromises.Interface` class are constructed using the `readlinePromises.createInterface()` method. Every instance is associated with a
10
10
  * single `input` `Readable` stream and a single `output` `Writable` stream.
11
11
  * The `output` stream is used to print prompts for user input that arrives on,
12
12
  * and is read from, the `input` stream.
@@ -15,12 +15,12 @@ declare module "readline/promises" {
15
15
  class Interface extends _Interface {
16
16
  /**
17
17
  * The `rl.question()` method displays the `query` by writing it to the `output`,
18
- * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument.
18
+ * waits for user input to be provided on `input`, then invokes the `callback` function passing the provided input as the first argument.
19
19
  *
20
20
  * When called, `rl.question()` will resume the `input` stream if it has been
21
21
  * paused.
22
22
  *
23
- * If the `Interface` was created with `output` set to `null` or`undefined` the `query` is not written.
23
+ * If the `Interface` was created with `output` set to `null` or `undefined` the `query` is not written.
24
24
  *
25
25
  * If the question is called after `rl.close()`, it returns a rejected promise.
26
26
  *
@@ -67,7 +67,7 @@ declare module "readline/promises" {
67
67
  * The `rl.clearLine()` method adds to the internal list of pending action an
68
68
  * action that clears current line of the associated `stream` in a specified
69
69
  * direction identified by `dir`.
70
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
70
+ * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
71
71
  * @since v17.0.0
72
72
  * @return this
73
73
  */
@@ -76,20 +76,20 @@ declare module "readline/promises" {
76
76
  * The `rl.clearScreenDown()` method adds to the internal list of pending action an
77
77
  * action that clears the associated stream from the current position of the
78
78
  * cursor down.
79
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
79
+ * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
80
80
  * @since v17.0.0
81
81
  * @return this
82
82
  */
83
83
  clearScreenDown(): this;
84
84
  /**
85
- * The `rl.commit()` method sends all the pending actions to the associated`stream` and clears the internal list of pending actions.
85
+ * The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
86
86
  * @since v17.0.0
87
87
  */
88
88
  commit(): Promise<void>;
89
89
  /**
90
90
  * The `rl.cursorTo()` method adds to the internal list of pending action an action
91
91
  * that moves cursor to the specified position in the associated `stream`.
92
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
92
+ * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
93
93
  * @since v17.0.0
94
94
  * @return this
95
95
  */
@@ -98,7 +98,7 @@ declare module "readline/promises" {
98
98
  * The `rl.moveCursor()` method adds to the internal list of pending action an
99
99
  * action that moves the cursor _relative_ to its current position in the
100
100
  * associated `stream`.
101
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
101
+ * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
102
102
  * @since v17.0.0
103
103
  * @return this
104
104
  */
@@ -112,7 +112,7 @@ declare module "readline/promises" {
112
112
  rollback(): this;
113
113
  }
114
114
  /**
115
- * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface`instance.
115
+ * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
116
116
  *
117
117
  * ```js
118
118
  * const readlinePromises = require('node:readline/promises');
node/readline.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  /**
2
- * The `node:readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time.
2
+ * The `node:readline` module provides an interface for reading data from a [Readable](https://nodejs.org/docs/latest-v20.x/api/stream.html#readable-streams) stream
3
+ * (such as [`process.stdin`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdin)) one line at a time.
3
4
  *
4
5
  * To use the promise-based APIs:
5
6
  *
@@ -13,7 +14,7 @@
13
14
  * import * as readline from 'node:readline';
14
15
  * ```
15
16
  *
16
- * The following simple example illustrates the basic use of the `node:readline`module.
17
+ * The following simple example illustrates the basic use of the `node:readline` module.
17
18
  *
18
19
  * ```js
19
20
  * import * as readline from 'node:readline/promises';
@@ -28,9 +29,9 @@
28
29
  * rl.close();
29
30
  * ```
30
31
  *
31
- * 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
32
+ * 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
32
33
  * received on the `input` stream.
33
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/readline.js)
34
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/readline.js)
34
35
  */
35
36
  declare module "readline" {
36
37
  import { Abortable, EventEmitter } from "node:events";
@@ -44,8 +45,8 @@ declare module "readline" {
44
45
  shift?: boolean | undefined;
45
46
  }
46
47
  /**
47
- * Instances of the `readline.Interface` class are constructed using the`readline.createInterface()` method. Every instance is associated with a
48
- * single `input` `Readable` stream and a single `output` `Writable` stream.
48
+ * Instances of the `readline.Interface` class are constructed using the `readline.createInterface()` method. Every instance is associated with a
49
+ * single `input` [Readable](https://nodejs.org/docs/latest-v20.x/api/stream.html#readable-streams) stream and a single `output` [Writable](https://nodejs.org/docs/latest-v20.x/api/stream.html#writable-streams) stream.
49
50
  * The `output` stream is used to print prompts for user input that arrives on,
50
51
  * and is read from, the `input` stream.
51
52
  * @since v0.1.104
@@ -123,7 +124,7 @@ declare module "readline" {
123
124
  */
124
125
  getPrompt(): string;
125
126
  /**
126
- * The `rl.setPrompt()` method sets the prompt that will be written to `output`whenever `rl.prompt()` is called.
127
+ * The `rl.setPrompt()` method sets the prompt that will be written to `output` whenever `rl.prompt()` is called.
127
128
  * @since v0.1.98
128
129
  */
129
130
  setPrompt(prompt: string): void;
@@ -134,19 +135,19 @@ declare module "readline" {
134
135
  * When called, `rl.prompt()` will resume the `input` stream if it has been
135
136
  * paused.
136
137
  *
137
- * If the `Interface` was created with `output` set to `null` or`undefined` the prompt is not written.
138
+ * If the `Interface` was created with `output` set to `null` or `undefined` the prompt is not written.
138
139
  * @since v0.1.98
139
140
  * @param preserveCursor If `true`, prevents the cursor placement from being reset to `0`.
140
141
  */
141
142
  prompt(preserveCursor?: boolean): void;
142
143
  /**
143
144
  * The `rl.question()` method displays the `query` by writing it to the `output`,
144
- * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument.
145
+ * waits for user input to be provided on `input`, then invokes the `callback` function passing the provided input as the first argument.
145
146
  *
146
147
  * When called, `rl.question()` will resume the `input` stream if it has been
147
148
  * paused.
148
149
  *
149
- * If the `Interface` was created with `output` set to `null` or`undefined` the `query` is not written.
150
+ * If the `Interface` was created with `output` set to `null` or `undefined` the `query` is not written.
150
151
  *
151
152
  * The `callback` function passed to `rl.question()` does not follow the typical
152
153
  * pattern of accepting an `Error` object or `null` as the first argument.
@@ -188,7 +189,7 @@ declare module "readline" {
188
189
  * The `rl.pause()` method pauses the `input` stream, allowing it to be resumed
189
190
  * later if necessary.
190
191
  *
191
- * Calling `rl.pause()` does not immediately pause other events (including`'line'`) from being emitted by the `Interface` instance.
192
+ * Calling `rl.pause()` does not immediately pause other events (including `'line'`) from being emitted by the `Interface` instance.
192
193
  * @since v0.3.4
193
194
  */
194
195
  pause(): this;
@@ -218,7 +219,7 @@ declare module "readline" {
218
219
  * When called, `rl.write()` will resume the `input` stream if it has been
219
220
  * paused.
220
221
  *
221
- * If the `Interface` was created with `output` set to `null` or`undefined` the `data` and `key` are not written.
222
+ * If the `Interface` was created with `output` set to `null` or `undefined` the `data` and `key` are not written.
222
223
  *
223
224
  * ```js
224
225
  * rl.write('Delete this!');
@@ -226,7 +227,7 @@ declare module "readline" {
226
227
  * rl.write(null, { ctrl: true, name: 'u' });
227
228
  * ```
228
229
  *
229
- * The `rl.write()` method will write the data to the `readline` `Interface`'s`input`_as if it were provided by the user_.
230
+ * The `rl.write()` method will write the data to the `readline` `Interface`'s `input` _as if it were provided by the user_.
230
231
  * @since v0.1.98
231
232
  */
232
233
  write(data: string | Buffer, key?: Key): void;
@@ -338,7 +339,7 @@ declare module "readline" {
338
339
  tabSize?: number | undefined;
339
340
  }
340
341
  /**
341
- * The `readline.createInterface()` method creates a new `readline.Interface`instance.
342
+ * The `readline.createInterface()` method creates a new `readline.Interface` instance.
342
343
  *
343
344
  * ```js
344
345
  * const readline = require('node:readline');
@@ -382,7 +383,7 @@ declare module "readline" {
382
383
  *
383
384
  * If the `stream` is a `TTY`, then it must be in raw mode.
384
385
  *
385
- * This is automatically called by any readline instance on its `input` if the`input` is a terminal. Closing the `readline` instance does not stop
386
+ * This is automatically called by any readline instance on its `input` if the `input` is a terminal. Closing the `readline` instance does not stop
386
387
  * the `input` from emitting `'keypress'` events.
387
388
  *
388
389
  * ```js
@@ -467,7 +468,7 @@ declare module "readline" {
467
468
  * });
468
469
  * ```
469
470
  *
470
- * 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:
471
+ * 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:
471
472
  *
472
473
  * ```js
473
474
  * const { once } = require('node:events');
@@ -502,7 +503,7 @@ declare module "readline" {
502
503
  cols: number;
503
504
  }
504
505
  /**
505
- * The `readline.clearLine()` method clears current line of given `TTY` stream
506
+ * The `readline.clearLine()` method clears current line of given [TTY](https://nodejs.org/docs/latest-v20.x/api/tty.html) stream
506
507
  * in a specified direction identified by `dir`.
507
508
  * @since v0.7.7
508
509
  * @param callback Invoked once the operation completes.
@@ -510,7 +511,7 @@ declare module "readline" {
510
511
  */
511
512
  export function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
512
513
  /**
513
- * The `readline.clearScreenDown()` method clears the given `TTY` stream from
514
+ * The `readline.clearScreenDown()` method clears the given [TTY](https://nodejs.org/docs/latest-v20.x/api/tty.html) stream from
514
515
  * the current position of the cursor down.
515
516
  * @since v0.7.7
516
517
  * @param callback Invoked once the operation completes.
@@ -519,7 +520,7 @@ declare module "readline" {
519
520
  export function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
520
521
  /**
521
522
  * The `readline.cursorTo()` method moves cursor to the specified position in a
522
- * given `TTY` `stream`.
523
+ * given [TTY](https://nodejs.org/docs/latest-v20.x/api/tty.html) `stream`.
523
524
  * @since v0.7.7
524
525
  * @param callback Invoked once the operation completes.
525
526
  * @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`.
@@ -527,7 +528,7 @@ declare module "readline" {
527
528
  export function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
528
529
  /**
529
530
  * The `readline.moveCursor()` method moves the cursor _relative_ to its current
530
- * position in a given `TTY` `stream`.
531
+ * position in a given [TTY](https://nodejs.org/docs/latest-v20.x/api/tty.html) `stream`.
531
532
  * @since v0.7.7
532
533
  * @param callback Invoked once the operation completes.
533
534
  * @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`.
node/repl.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  * ```js
7
7
  * const repl = require('node:repl');
8
8
  * ```
9
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/repl.js)
9
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/repl.js)
10
10
  */
11
11
  declare module "repl" {
12
12
  import { AsyncCompleter, Completer, Interface } from "node:readline";
@@ -54,25 +54,25 @@ declare module "repl" {
54
54
  * If `true`, specifies that the default `writer` function should include ANSI color
55
55
  * styling to REPL output. If a custom `writer` function is provided then this has no
56
56
  * effect.
57
- * Default: the REPL instance's `terminal` value.
57
+ * @default the REPL instance's `terminal` value
58
58
  */
59
59
  useColors?: boolean | undefined;
60
60
  /**
61
61
  * If `true`, specifies that the default evaluation function will use the JavaScript
62
62
  * `global` as the context as opposed to creating a new separate context for the REPL
63
63
  * instance. The node CLI REPL sets this value to `true`.
64
- * Default: `false`.
64
+ * @default false
65
65
  */
66
66
  useGlobal?: boolean | undefined;
67
67
  /**
68
68
  * If `true`, specifies that the default writer will not output the return value of a
69
69
  * command if it evaluates to `undefined`.
70
- * Default: `false`.
70
+ * @default false
71
71
  */
72
72
  ignoreUndefined?: boolean | undefined;
73
73
  /**
74
74
  * The function to invoke to format the output of each command before writing to `output`.
75
- * Default: a wrapper for `util.inspect`.
75
+ * @default a wrapper for `util.inspect`
76
76
  *
77
77
  * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_customizing_repl_output
78
78
  */
@@ -95,7 +95,7 @@ declare module "repl" {
95
95
  /**
96
96
  * Stop evaluating the current piece of code when `SIGINT` is received, i.e. `Ctrl+C` is
97
97
  * pressed. This cannot be used together with a custom `eval` function.
98
- * Default: `false`.
98
+ * @default false
99
99
  */
100
100
  breakEvalOnSigint?: boolean | undefined;
101
101
  }
@@ -297,7 +297,7 @@ declare module "repl" {
297
297
  * When `preserveCursor` is `true`, the cursor placement will not be reset to `0`.
298
298
  *
299
299
  * The `replServer.displayPrompt` method is primarily intended to be called from
300
- * within the action function for commands registered using the`replServer.defineCommand()` method.
300
+ * within the action function for commands registered using the `replServer.defineCommand()` method.
301
301
  * @since v0.1.91
302
302
  */
303
303
  displayPrompt(preserveCursor?: boolean): void;
node/stream/web.d.ts CHANGED
@@ -351,7 +351,7 @@ declare module "stream/web" {
351
351
  }
352
352
  const CompressionStream: {
353
353
  prototype: CompressionStream;
354
- new<R = any, W = any>(format: string): CompressionStream<R, W>;
354
+ new<R = any, W = any>(format: "deflate" | "deflate-raw" | "gzip"): CompressionStream<R, W>;
355
355
  };
356
356
  interface DecompressionStream<R = any, W = any> {
357
357
  readonly readable: ReadableStream<R>;
@@ -359,7 +359,7 @@ declare module "stream/web" {
359
359
  }
360
360
  const DecompressionStream: {
361
361
  prototype: DecompressionStream;
362
- new<R = any, W = any>(format: string): DecompressionStream<R, W>;
362
+ new<R = any, W = any>(format: "deflate" | "deflate-raw" | "gzip"): DecompressionStream<R, W>;
363
363
  };
364
364
  }
365
365
  declare module "node:stream/web" {
node/stream.d.ts CHANGED
@@ -14,7 +14,7 @@
14
14
  *
15
15
  * The `node:stream` module is useful for creating new types of stream instances.
16
16
  * It is usually not necessary to use the `node:stream` module to consume streams.
17
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/stream.js)
17
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/stream.js)
18
18
  */
19
19
  declare module "stream" {
20
20
  import { Abortable, EventEmitter } from "node:events";
@@ -41,7 +41,9 @@ declare module "stream" {
41
41
  import Readable = internal.Readable;
42
42
  import ReadableOptions = internal.ReadableOptions;
43
43
  interface ArrayOptions {
44
- /** the maximum concurrent invocations of `fn` to call on the stream at once. **Default: 1**. */
44
+ /** the maximum concurrent invocations of `fn` to call on the stream at once.
45
+ * @default 1
46
+ */
45
47
  concurrency?: number;
46
48
  /** allows destroying the stream if the signal is aborted. */
47
49
  signal?: AbortSignal;
@@ -75,7 +77,7 @@ declare module "stream" {
75
77
  */
76
78
  readonly readableDidRead: boolean;
77
79
  /**
78
- * Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.
80
+ * Getter for the property `encoding` of a given `Readable` stream. The `encoding` property can be set using the `readable.setEncoding()` method.
79
81
  * @since v12.7.0
80
82
  */
81
83
  readonly readableEncoding: BufferEncoding | null;
@@ -132,7 +134,7 @@ declare module "stream" {
132
134
  * specified using the `readable.setEncoding()` method or the stream is operating
133
135
  * in object mode.
134
136
  *
135
- * The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which
137
+ * The optional `size` argument specifies a specific number of bytes to read. If `size` bytes are not available to be read, `null` will be returned _unless_ the stream has ended, in which
136
138
  * case all of the data remaining in the internal
137
139
  * buffer will be returned.
138
140
  *
@@ -207,7 +209,7 @@ declare module "stream" {
207
209
  * data read from the `Readable` stream.
208
210
  *
209
211
  * By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data
210
- * to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the
212
+ * to be returned as strings of the specified encoding rather than as `Buffer` objects. For instance, calling `readable.setEncoding('utf8')` will cause the
211
213
  * output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal
212
214
  * string format.
213
215
  *
@@ -379,7 +381,7 @@ declare module "stream" {
379
381
  */
380
382
  unshift(chunk: any, encoding?: BufferEncoding): void;
381
383
  /**
382
- * Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
384
+ * Prior to Node.js 0.10, streams did not implement the entire `node:stream` module API as it is currently defined. (See `Compatibility` for more
383
385
  * information.)
384
386
  *
385
387
  * When using an older Node.js library that emits `'data'` events and has a {@link pause} method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
node/string_decoder.d.ts CHANGED
@@ -36,7 +36,7 @@
36
36
  * decoder.write(Buffer.from([0x82]));
37
37
  * console.log(decoder.end(Buffer.from([0xAC]))); // Prints: €
38
38
  * ```
39
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/string_decoder.js)
39
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/string_decoder.js)
40
40
  */
41
41
  declare module "string_decoder" {
42
42
  class StringDecoder {
@@ -44,7 +44,7 @@ declare module "string_decoder" {
44
44
  /**
45
45
  * Returns a decoded string, ensuring that any incomplete multibyte characters at
46
46
  * the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the
47
- * returned string and stored in an internal buffer for the next call to`stringDecoder.write()` or `stringDecoder.end()`.
47
+ * returned string and stored in an internal buffer for the next call to `stringDecoder.write()` or `stringDecoder.end()`.
48
48
  * @since v0.1.99
49
49
  * @param buffer The bytes to decode.
50
50
  */
@@ -54,7 +54,7 @@ declare module "string_decoder" {
54
54
  * representing incomplete UTF-8 and UTF-16 characters will be replaced with
55
55
  * substitution characters appropriate for the character encoding.
56
56
  *
57
- * If the `buffer` argument is provided, one final call to `stringDecoder.write()`is performed before returning the remaining input.
57
+ * If the `buffer` argument is provided, one final call to `stringDecoder.write()` is performed before returning the remaining input.
58
58
  * After `end()` is called, the `stringDecoder` object can be reused for new input.
59
59
  * @since v0.9.3
60
60
  * @param buffer The bytes to decode.
node/test.d.ts CHANGED
@@ -18,14 +18,14 @@
18
18
  *
19
19
  * 1. A synchronous function that is considered failing if it throws an exception,
20
20
  * and is considered passing otherwise.
21
- * 2. A function that returns a `Promise` that is considered failing if the`Promise` rejects, and is considered passing if the `Promise` fulfills.
21
+ * 2. A function that returns a `Promise` that is considered failing if the `Promise` rejects, and is considered passing if the `Promise` fulfills.
22
22
  * 3. A function that receives a callback function. If the callback receives any
23
23
  * truthy value as its first argument, the test is considered failing. If a
24
24
  * falsy value is passed as the first argument to the callback, the test is
25
25
  * considered passing. If the test function receives a callback function and
26
26
  * also returns a `Promise`, the test will fail.
27
27
  *
28
- * The following example illustrates how tests are written using the`test` module.
28
+ * The following example illustrates how tests are written using the `test` module.
29
29
  *
30
30
  * ```js
31
31
  * test('synchronous passing test', (t) => {
@@ -76,13 +76,13 @@
76
76
  *
77
77
  * If any tests fail, the process exit code is set to `1`.
78
78
  * @since v18.0.0, v16.17.0
79
- * @see [source](https://github.com/nodejs/node/blob/v20.4.0/lib/test.js)
79
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/test.js)
80
80
  */
81
81
  declare module "node:test" {
82
82
  import { Readable } from "node:stream";
83
83
  import { AsyncResource } from "node:async_hooks";
84
84
  /**
85
- * **Note:**`shard` is used to horizontally parallelize test running across
85
+ * **Note:** `shard` is used to horizontally parallelize test running across
86
86
  * machines or processes, ideal for large-scale executions across varied
87
87
  * environments. It's incompatible with `watch` mode, tailored for rapid
88
88
  * code iteration by automatically rerunning tests on file changes.
@@ -129,14 +129,14 @@ declare module "node:test" {
129
129
  * });
130
130
  * ```
131
131
  *
132
- * The `timeout` option can be used to fail the test if it takes longer than`timeout` milliseconds to complete. However, it is not a reliable mechanism for
132
+ * The `timeout` option can be used to fail the test if it takes longer than `timeout` milliseconds to complete. However, it is not a reliable mechanism for
133
133
  * canceling tests because a running test might block the application thread and
134
134
  * thus prevent the scheduled cancellation.
135
135
  * @since v18.0.0, v16.17.0
136
136
  * @param [name='The name'] The name of the test, which is displayed when reporting test results.
137
137
  * @param options Configuration options for the test. The following properties are supported:
138
- * @param [fn='A no-op function'] The function under test. The first argument to this function is a {@link TestContext} object. If the test uses callbacks, the callback function is passed as the
139
- * second argument.
138
+ * @param [fn='A no-op function'] The function under test. The first argument to this function is a {@link TestContext} object. If the test uses callbacks, the
139
+ * callback function is passed as the second argument.
140
140
  * @return Fulfilled with `undefined` once the test completes, or immediately if the test runs within {@link describe}.
141
141
  */
142
142
  function test(name?: string, fn?: TestFn): Promise<void>;
@@ -328,7 +328,7 @@ declare module "node:test" {
328
328
  timeout: number | null;
329
329
  }
330
330
  /**
331
- * A successful call to `run()` method will return a new `TestsStream` object, streaming a series of events representing the execution of the tests.`TestsStream` will emit events, in the
331
+ * A successful call to `run()` method will return a new `TestsStream` object, streaming a series of events representing the execution of the tests. `TestsStream` will emit events, in the
332
332
  * order of the tests definition
333
333
  * @since v18.9.0, v16.19.0
334
334
  */
@@ -392,7 +392,7 @@ declare module "node:test" {
392
392
  /**
393
393
  * This function is used to create a hook running before subtest of the current test.
394
394
  * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
395
- * the second argument. Default: A no-op function.
395
+ * the second argument. **Default:** A no-op function.
396
396
  * @param options Configuration options for the hook.
397
397
  * @since v20.1.0
398
398
  */
@@ -400,14 +400,14 @@ declare module "node:test" {
400
400
  /**
401
401
  * This function is used to create a hook running before each subtest of the current test.
402
402
  * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
403
- * the second argument. Default: A no-op function.
403
+ * the second argument. **Default:** A no-op function.
404
404
  * @param options Configuration options for the hook.
405
405
  * @since v18.8.0
406
406
  */
407
407
  beforeEach: typeof beforeEach;
408
408
  /**
409
409
  * This function is used to create a hook that runs after the current test finishes.
410
- * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
410
+ * @param [fn='A no-op function'] The hook function. If the hook uses callbacks, the callback function is passed as
411
411
  * the second argument. Default: A no-op function.
412
412
  * @param options Configuration options for the hook.
413
413
  * @since v18.13.0
@@ -416,7 +416,7 @@ declare module "node:test" {
416
416
  /**
417
417
  * This function is used to create a hook running after each subtest of the current test.
418
418
  * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
419
- * the second argument. Default: A no-op function.
419
+ * the second argument. **Default:** A no-op function.
420
420
  * @param options Configuration options for the hook.
421
421
  * @since v18.8.0
422
422
  */
@@ -470,7 +470,7 @@ declare module "node:test" {
470
470
  */
471
471
  readonly signal: AbortSignal;
472
472
  /**
473
- * This function causes the test's output to indicate the test as skipped. If`message` is provided, it is included in the output. Calling `skip()` does
473
+ * This function causes the test's output to indicate the test as skipped. If `message` is provided, it is included in the output. Calling `skip()` does
474
474
  * not terminate execution of the test function. This function does not return a
475
475
  * value.
476
476
  *
@@ -508,7 +508,7 @@ declare module "node:test" {
508
508
  * @param options Configuration options for the test
509
509
  * @param fn The function under test. This first argument to this function is a
510
510
  * {@link TestContext} object. If the test uses callbacks, the callback function is
511
- * passed as the second argument. Default: A no-op function.
511
+ * passed as the second argument. **Default:** A no-op function.
512
512
  * @returns A {@link Promise} resolved with `undefined` once the test completes.
513
513
  */
514
514
  test: typeof test;
@@ -695,7 +695,7 @@ declare module "node:test" {
695
695
  /**
696
696
  * The `MockTracker` class is used to manage mocking functionality. The test runner
697
697
  * module provides a top level `mock` export which is a `MockTracker` instance.
698
- * Each test also provides its own `MockTracker` instance via the test context's`mock` property.
698
+ * Each test also provides its own `MockTracker` instance via the test context's `mock` property.
699
699
  * @since v19.1.0, v18.13.0
700
700
  */
701
701
  class MockTracker {
@@ -811,7 +811,7 @@ declare module "node:test" {
811
811
  ): Mock<Function>;
812
812
 
813
813
  /**
814
- * This function is syntax sugar for `MockTracker.method` with `options.getter`set to `true`.
814
+ * This function is syntax sugar for `MockTracker.method` with `options.getter` set to `true`.
815
815
  * @since v19.3.0, v18.13.0
816
816
  */
817
817
  getter<
@@ -833,7 +833,7 @@ declare module "node:test" {
833
833
  options?: MockFunctionOptions,
834
834
  ): Mock<(() => MockedObject[MethodName]) | Implementation>;
835
835
  /**
836
- * This function is syntax sugar for `MockTracker.method` with `options.setter`set to `true`.
836
+ * This function is syntax sugar for `MockTracker.method` with `options.setter` set to `true`.
837
837
  * @since v19.3.0, v18.13.0
838
838
  */
839
839
  setter<
@@ -856,11 +856,11 @@ declare module "node:test" {
856
856
  ): Mock<((value: MockedObject[MethodName]) => void) | Implementation>;
857
857
  /**
858
858
  * This function restores the default behavior of all mocks that were previously
859
- * created by this `MockTracker` and disassociates the mocks from the`MockTracker` instance. Once disassociated, the mocks can still be used, but the`MockTracker` instance can no longer be
859
+ * created by this `MockTracker` and disassociates the mocks from the `MockTracker` instance. Once disassociated, the mocks can still be used, but the `MockTracker` instance can no longer be
860
860
  * used to reset their behavior or
861
861
  * otherwise interact with them.
862
862
  *
863
- * After each test completes, this function is called on the test context's`MockTracker`. If the global `MockTracker` is used extensively, calling this
863
+ * After each test completes, this function is called on the test context's `MockTracker`. If the global `MockTracker` is used extensively, calling this
864
864
  * function manually is recommended.
865
865
  * @since v19.1.0, v18.13.0
866
866
  */
@@ -926,7 +926,7 @@ declare module "node:test" {
926
926
  readonly calls: Array<MockFunctionCall<F>>;
927
927
  /**
928
928
  * This function returns the number of times that this mock has been invoked. This
929
- * function is more efficient than checking `ctx.calls.length` because `ctx.calls`is a getter that creates a copy of the internal call tracking array.
929
+ * function is more efficient than checking `ctx.calls.length` because `ctx.calls` is a getter that creates a copy of the internal call tracking array.
930
930
  * @since v19.1.0, v18.13.0
931
931
  * @return The number of times that this mock has been invoked.
932
932
  */
@@ -1050,7 +1050,7 @@ declare module "node:test" {
1050
1050
  *
1051
1051
  * The above example enables mocking for the `Date` constructor, `setInterval` timer and
1052
1052
  * implicitly mocks the `clearInterval` function. Only the `Date` constructor from `globalThis`,
1053
- * `setInterval` and `clearInterval` functions from `node:timers`,`node:timers/promises`, and `globalThis` will be mocked.
1053
+ * `setInterval` and `clearInterval` functions from `node:timers`, `node:timers/promises`, and `globalThis` will be mocked.
1054
1054
  *
1055
1055
  * Example usage with initial time set
1056
1056
  *
@@ -1075,7 +1075,9 @@ declare module "node:test" {
1075
1075
  * and `globalThis` will be mocked.
1076
1076
  * The `Date` constructor from `globalThis` will be mocked.
1077
1077
  *
1078
- * If there is no initial epoch set, the initial date will be based on 0 in the Unix epoch. This is `January 1st, 1970, 00:00:00 UTC`. You can set an initial date by passing a now property to the `.enable()` method. This value will be used as the initial date for the mocked Date object. It can either be a positive integer, or another Date object.
1078
+ * If there is no initial epoch set, the initial date will be based on 0 in the Unix epoch. This is `January 1st, 1970, 00:00:00 UTC`. You can
1079
+ * set an initial date by passing a now property to the `.enable()` method. This value will be used as the initial date for the mocked Date
1080
+ * object. It can either be a positive integer, or another Date object.
1079
1081
  * @since v20.4.0
1080
1082
  */
1081
1083
  enable(options?: MockTimersOptions): void;
@@ -1420,7 +1422,7 @@ interface TestDequeue extends TestLocationInfo {
1420
1422
  * import test from 'test/reporters';
1421
1423
  * ```
1422
1424
  * @since v19.9.0
1423
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/test/reporters.js)
1425
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/test/reporters.js)
1424
1426
  */
1425
1427
  declare module "node:test/reporters" {
1426
1428
  import { Transform, TransformOptions } from "node:stream";
node/timers/promises.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * The `timers/promises` API provides an alternative set of timer functions
3
- * that return `Promise` objects. The API is accessible via`require('node:timers/promises')`.
3
+ * that return `Promise` objects. The API is accessible via `require('node:timers/promises')`.
4
4
  *
5
5
  * ```js
6
6
  * import {
@@ -66,21 +66,25 @@ declare module "timers/promises" {
66
66
  function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
67
67
  interface Scheduler {
68
68
  /**
69
+ * An experimental API defined by the [Scheduling APIs](https://github.com/WICG/scheduling-apis) draft specification being developed as a standard Web Platform API.
70
+ *
71
+ * Calling `timersPromises.scheduler.wait(delay, options)` is roughly equivalent to calling `timersPromises.setTimeout(delay, undefined, options)` except that the `ref`
72
+ * option is not supported.
73
+ *
69
74
  * ```js
70
75
  * import { scheduler } from 'node:timers/promises';
71
76
  *
72
77
  * await scheduler.wait(1000); // Wait one second before continuing
73
78
  * ```
74
- * An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.
75
- * Calling timersPromises.scheduler.wait(delay, options) is roughly equivalent to calling timersPromises.setTimeout(delay, undefined, options) except that the ref option is not supported.
76
79
  * @since v16.14.0
77
80
  * @experimental
78
81
  * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
79
82
  */
80
- wait: (delay?: number, options?: TimerOptions) => Promise<void>;
83
+ wait: (delay?: number, options?: Pick<TimerOptions, "signal">) => Promise<void>;
81
84
  /**
82
- * An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.
83
- * Calling timersPromises.scheduler.yield() is equivalent to calling timersPromises.setImmediate() with no arguments.
85
+ * An experimental API defined by the [Scheduling APIs](https://nodejs.org/docs/latest-v20.x/api/async_hooks.html#promise-execution-tracking) draft specification
86
+ * being developed as a standard Web Platform API.
87
+ * Calling `timersPromises.scheduler.yield()` is equivalent to calling `timersPromises.setImmediate()` with no arguments.
84
88
  * @since v16.14.0
85
89
  * @experimental
86
90
  */