@types/node 20.19.25 → 24.10.3

{node v20.19 → node v24.10}/child_process.d.ts

@@ -24,7 +24,7 @@
  * the parent Node.js process and the spawned subprocess. These pipes have
  * limited (and platform-specific) capacity. If the subprocess writes to
  * stdout in excess of that limit without the output being captured, the
- * subprocess blocks waiting for the pipe buffer to accept more data. This is
+ * subprocess blocks, waiting for the pipe buffer to accept more data. This is
  * identical to the behavior of pipes in the shell. Use the `{ stdio: 'ignore' }` option if the output will not be consumed.
  *
  * The command lookup is performed using the `options.env.PATH` environment
@@ -63,7 +63,7 @@
  * For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however,
  * the synchronous methods can have significant impact on performance due to
  * stalling the event loop while spawned processes complete.
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/child_process.js)
+ * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/child_process.js)
  */
 declare module "child_process" {
     import { NonSharedBuffer } from "node:buffer";
@@ -374,12 +374,12 @@ declare module "child_process" {
          * a TCP server object to the child process as illustrated in the example below:
          *
          * ```js
-         * import child_process from 'node:child_process';
-         * const subprocess = child_process.fork('subprocess.js');
+         * import { createServer } from 'node:net';
+         * import { fork } from 'node:child_process';
+         * const subprocess = fork('subprocess.js');
          *
          * // Open up the server object and send the handle.
-         * import net from 'node:net';
-         * const server = net.createServer();
+         * const server = createServer();
          * server.on('connection', (socket) => {
          *   socket.end('handled by parent');
          * });
@@ -414,14 +414,14 @@ declare module "child_process" {
          * handle connections with "normal" or "special" priority:
          *
          * ```js
+         * import { createServer } from 'node:net';
          * import { fork } from 'node:child_process';
          * const normal = fork('subprocess.js', ['normal']);
          * const special = fork('subprocess.js', ['special']);
          *
          * // Open up the server and send sockets to child. Use pauseOnConnect to prevent
          * // the sockets from being read before they are sent to the child process.
-         * import net from 'node:net';
-         * const server = net.createServer({ pauseOnConnect: true });
+         * const server = createServer({ pauseOnConnect: true });
          * server.on('connection', (socket) => {
          *
          *   // If this is special priority...
@@ -458,7 +458,7 @@ declare module "child_process" {
          * as the connection may have been closed during the time it takes to send the
          * connection to the child.
          * @since v0.5.9
-         * @param sendHandle `undefined`, or a [`net.Socket`](https://nodejs.org/docs/latest-v20.x/api/net.html#class-netsocket), [`net.Server`](https://nodejs.org/docs/latest-v20.x/api/net.html#class-netserver), or [`dgram.Socket`](https://nodejs.org/docs/latest-v20.x/api/dgram.html#class-dgramsocket) object.
+         * @param sendHandle `undefined`, or a [`net.Socket`](https://nodejs.org/docs/latest-v24.x/api/net.html#class-netsocket), [`net.Server`](https://nodejs.org/docs/latest-v24.x/api/net.html#class-netserver), or [`dgram.Socket`](https://nodejs.org/docs/latest-v24.x/api/dgram.html#class-dgramsocket) object.
          * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
          */
         send(message: Serializable, callback?: (error: Error | null) => void): boolean;
@@ -1105,7 +1105,8 @@ declare module "child_process" {
      *
      * ```js
      * import util from 'node:util';
-     * const execFile = util.promisify(require('node:child_process').execFile);
+     * import child_process from 'node:child_process';
+     * const execFile = util.promisify(child_process.execFile);
      * async function getVersion() {
      *   const { stdout } = await execFile('node', ['--version']);
      *   console.log(stdout);

{node v20.19 → node v24.10}/cluster.d.ts

@@ -1,7 +1,7 @@
 /**
  * Clusters of Node.js processes can be used to run multiple instances of Node.js
  * that can distribute workloads among their application threads. When process isolation
- * is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html)
+ * is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v24.x/api/worker_threads.html)
  * module instead, which allows running multiple application threads within a single Node.js instance.
  *
  * The cluster module allows easy creation of child processes that all share
@@ -50,7 +50,7 @@
  * ```
  *
  * On Windows, it is not yet possible to set up a named pipe server in a worker.
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/cluster.js)
+ * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/cluster.js)
  */
 declare module "cluster" {
     import * as child from "node:child_process";
@@ -80,8 +80,8 @@ declare module "cluster" {
         silent?: boolean | undefined;
         /**
          * Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
-         * contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processspawncommand-args-options)'s
-         * [`stdio`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#optionsstdio).
+         * contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processspawncommand-args-options)'s
+         * [`stdio`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#optionsstdio).
          */
         stdio?: any[] | undefined;
         /**
@@ -99,7 +99,7 @@ declare module "cluster" {
         inspectPort?: number | (() => number) | undefined;
         /**
          * Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
-         * See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#advanced-serialization) for more details.
+         * See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#advanced-serialization) for more details.
          * @default false
          */
         serialization?: SerializationType | undefined;
@@ -142,10 +142,10 @@ declare module "cluster" {
          */
         id: number;
         /**
-         * All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
+         * All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
          * from this function is stored as `.process`. In a worker, the global `process` is stored.
          *
-         * See: [Child Process module](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options).
+         * See: [Child Process module](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processforkmodulepath-args-options).
          *
          * Workers will call `process.exit(0)` if the `'disconnect'` event occurs
          * on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
@@ -156,7 +156,7 @@ declare module "cluster" {
         /**
          * Send a message to a worker or primary, optionally with a handle.
          *
-         * In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
+         * In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
          *
          * In a worker, this sends a message to the primary. It is identical to `process.send()`.
          *
@@ -198,7 +198,7 @@ declare module "cluster" {
          * This method is aliased as `worker.destroy()` for backwards compatibility.
          *
          * In a worker, `process.kill()` exists, but it is not this function;
-         * it is [`kill()`](https://nodejs.org/docs/latest-v20.x/api/process.html#processkillpid-signal).
+         * it is [`kill()`](https://nodejs.org/docs/latest-v24.x/api/process.html#processkillpid-signal).
          * @since v0.9.12
          * @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
          */
@@ -232,6 +232,7 @@ declare module "cluster" {
          *
          * ```js
          * import net from 'node:net';
+         *
          * if (cluster.isPrimary) {
          *   const worker = cluster.fork();
          *   let timeout;
@@ -411,7 +412,7 @@ declare module "cluster" {
         readonly isWorker: boolean;
         /**
          * The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
-         * global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
+         * global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings)
          * is called, whichever comes first.
          *
          * `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
@@ -422,24 +423,24 @@ declare module "cluster" {
          */
         schedulingPolicy: number;
         /**
-         * After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
-         * (or [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)) this settings object will contain
+         * After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings)
+         * (or [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv)) this settings object will contain
          * the settings, including the default values.
          *
          * This object is not intended to be changed or set manually.
          * @since v0.7.1
          */
         readonly settings: ClusterSettings;
-        /** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings) instead. */
+        /** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings) instead. */
         setupMaster(settings?: ClusterSettings): void;
         /**
          * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
          *
-         * Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)
+         * Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv)
          * and have no effect on workers that are already running.
          *
          * The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
-         * [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv).
+         * [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv).
          *
          * The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
          * `cluster.setupPrimary()` is called.

{node v20.19 → node v24.10}/console.d.ts

@@ -5,12 +5,12 @@
  * The module exports two specific components:
  *
  * * A `Console` class with methods such as `console.log()`, `console.error()`, and `console.warn()` that can be used to write to any Node.js stream.
- * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and
- * [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
+ * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v24.x/api/process.html#processstdout) and
+ * [`process.stderr`](https://nodejs.org/docs/latest-v24.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
  *
  * _**Warning**_: The global console object's methods are neither consistently
  * synchronous like the browser APIs they resemble, nor are they consistently
- * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for
+ * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v24.x/api/process.html#a-note-on-process-io) for
  * more information.
  *
  * Example using the global `console`:
@@ -54,7 +54,7 @@
  * myConsole.warn(`Danger ${name}! Danger!`);
  * // Prints: Danger Will Robinson! Danger!, to err
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/console.js)
+ * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/console.js)
  */
 declare module "console" {
     import console = require("node:console");
@@ -70,7 +70,7 @@ declare module "node:console" {
              * `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
              * writes a message and does not otherwise affect execution. The output always
              * starts with `"Assertion failed"`. If provided, `message` is formatted using
-             * [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args).
+             * [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args).
              *
              * If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
              *
@@ -152,7 +152,7 @@ declare module "node:console" {
              */
             debug(message?: any, ...optionalParams: any[]): void;
             /**
-             * Uses [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options) on `obj` and prints the resulting string to `stdout`.
+             * Uses [`util.inspect()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilinspectobject-options) on `obj` and prints the resulting string to `stdout`.
              * This function bypasses any custom `inspect()` function defined on `obj`.
              * @since v0.1.101
              */
@@ -167,7 +167,7 @@ declare module "node:console" {
              * Prints to `stderr` with newline. Multiple arguments can be passed, with the
              * first used as the primary message and all additional used as substitution
              * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
-             * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)).
+             * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args)).
              *
              * ```js
              * const code = 5;
@@ -178,8 +178,8 @@ declare module "node:console" {
              * ```
              *
              * If formatting elements (e.g. `%d`) are not found in the first string then
-             * [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options) is called on each argument and the
-             * resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)
+             * [`util.inspect()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilinspectobject-options) is called on each argument and the
+             * resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args)
              * for more information.
              * @since v0.1.100
              */
@@ -211,7 +211,7 @@ declare module "node:console" {
              * Prints to `stdout` with newline. Multiple arguments can be passed, with the
              * first used as the primary message and all additional used as substitution
              * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
-             * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)).
+             * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args)).
              *
              * ```js
              * const count = 5;
@@ -221,7 +221,7 @@ declare module "node:console" {
              * // Prints: count: 5, to stdout
              * ```
              *
-             * See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args) for more information.
+             * See [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args) for more information.
              * @since v0.1.100
              */
             log(message?: any, ...optionalParams: any[]): void;
@@ -297,7 +297,7 @@ declare module "node:console" {
              */
             timeLog(label?: string, ...data: any[]): void;
             /**
-             * Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)
+             * Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-v24.x/api/util.html#utilformatformat-args)
              * formatted message and stack trace to the current position in the code.
              *
              * ```js
@@ -361,12 +361,12 @@ declare module "node:console" {
          * The module exports two specific components:
          *
          * * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream.
-         * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and
-         * [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
+         * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v24.x/api/process.html#processstdout) and
+         * [`process.stderr`](https://nodejs.org/docs/latest-v24.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
          *
          * _**Warning**_: The global console object's methods are neither consistently
          * synchronous like the browser APIs they resemble, nor are they consistently
-         * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for
+         * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v24.x/api/process.html#a-note-on-process-io) for
          * more information.
          *
          * Example using the global `console`:
@@ -410,7 +410,7 @@ declare module "node:console" {
          * myConsole.warn(`Danger ${name}! Danger!`);
          * // Prints: Danger Will Robinson! Danger!, to err
          * ```
-         * @see [source](https://github.com/nodejs/node/blob/v20.11.1/lib/console.js)
+         * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/console.js)
          */
         namespace console {
             interface ConsoleConstructorOptions {
@@ -431,9 +431,10 @@ declare module "node:console" {
                 colorMode?: boolean | "auto" | undefined;
                 /**
                  * Specifies options that are passed along to
-                 * [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options).
+                 * `util.inspect()`. Can be an options object or, if different options
+                 * for stdout and stderr are desired, a `Map` from stream objects to options.
                  */
-                inspectOptions?: InspectOptions | undefined;
+                inspectOptions?: InspectOptions | ReadonlyMap<NodeJS.WritableStream, InspectOptions> | undefined;
                 /**
                  * Set group indentation.
                  * @default 2