@types/node 22.7.0 → 22.7.2

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Wed, 25 Sep 2024 00:56:18 GMT
+ * Last updated: Wed, 25 Sep 2024 22:07:42 GMT
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
 
 # Credits

node/async_hooks.d.ts

@@ -77,7 +77,7 @@ declare module "async_hooks" {
      *   executionAsyncId,
      *   executionAsyncResource,
      *   createHook,
-     * } from 'async_hooks';
+     * } from 'node:async_hooks';
      * const sym = Symbol('state'); // Private symbol to avoid pollution
      *
      * createHook({

node/buffer.d.ts

@@ -134,7 +134,7 @@ declare module "buffer" {
     export interface BlobOptions {
         /**
          * One of either `'transparent'` or `'native'`. When set to `'native'`, line endings in string source parts
-         * will be converted to the platform native line-ending as specified by `require('node:os').EOL`.
+         * will be converted to the platform native line-ending as specified by `import { EOL } from 'node:os'`.
          */
         endings?: "transparent" | "native";
         /**
@@ -210,7 +210,7 @@ declare module "buffer" {
     export interface FileOptions {
         /**
          * One of either `'transparent'` or `'native'`. When set to `'native'`, line endings in string source parts will be
-         * converted to the platform native line-ending as specified by `require('node:os').EOL`.
+         * converted to the platform native line-ending as specified by `import { EOL } from 'node:os'`.
          */
         endings?: "native" | "transparent";
         /** The File content-type. */
@@ -261,6 +261,13 @@ declare module "buffer" {
             | {
                 valueOf(): T;
             };
+        // `WithArrayBufferLike` is a backwards-compatible workaround for the addition of a `TArrayBuffer` type parameter to
+        // `Uint8Array` to ensure that `Buffer` remains assignment-compatible with `Uint8Array`, but without the added
+        // complexity involved with making `Buffer` itself generic as that would require re-introducing `"typesVersions"` to
+        // the NodeJS types. It is likely this interface will become deprecated in the future once `Buffer` does become generic.
+        interface WithArrayBufferLike<TArrayBuffer extends ArrayBufferLike> {
+            readonly buffer: TArrayBuffer;
+        }
         /**
          * Raw data is stored in instances of the Buffer class.
          * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap.  A Buffer cannot be resized.
@@ -912,7 +919,7 @@ declare module "buffer" {
              * @param [start=0] Where the new `Buffer` will start.
              * @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
              */
-            slice(start?: number, end?: number): Buffer;
+            slice(start?: number, end?: number): Buffer & WithArrayBufferLike<ArrayBuffer>;
             /**
              * Returns a new `Buffer` that references the same memory as the original, but
              * offset and cropped by the `start` and `end` indices.
@@ -972,7 +979,7 @@ declare module "buffer" {
              * @param [start=0] Where the new `Buffer` will start.
              * @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
              */
-            subarray(start?: number, end?: number): Buffer;
+            subarray(start?: number, end?: number): Buffer & WithArrayBufferLike<this["buffer"]>;
             /**
              * Writes `value` to `buf` at the specified `offset` as big-endian.
              *
@@ -1630,7 +1637,7 @@ declare module "buffer" {
              * @since v5.10.0
              * @return A reference to `buf`.
              */
-            swap16(): Buffer;
+            swap16(): this;
             /**
              * Interprets `buf` as an array of unsigned 32-bit integers and swaps the
              * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
@@ -1656,7 +1663,7 @@ declare module "buffer" {
              * @since v5.10.0
              * @return A reference to `buf`.
              */
-            swap32(): Buffer;
+            swap32(): this;
             /**
              * Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
              * Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8.
@@ -1682,7 +1689,7 @@ declare module "buffer" {
              * @since v6.3.0
              * @return A reference to `buf`.
              */
-            swap64(): Buffer;
+            swap64(): this;
             /**
              * Writes `value` to `buf` at the specified `offset`. `value` must be a
              * valid unsigned 8-bit integer. Behavior is undefined when `value` is anything
@@ -2279,7 +2286,7 @@ declare module "buffer" {
         function btoa(data: string): string;
         interface Blob extends _Blob {}
         /**
-         * `Blob` class is a global reference for `require('node:buffer').Blob`
+         * `Blob` class is a global reference for `import { Blob } from 'node:buffer'`
          * https://nodejs.org/api/buffer.html#class-blob
          * @since v18.0.0
          */
@@ -2287,7 +2294,7 @@ declare module "buffer" {
             : typeof import("buffer").Blob;
         interface File extends _File {}
         /**
-         * `File` class is a global reference for `require('node:buffer').File`
+         * `File` class is a global reference for `import { File } from 'node:buffer'`
          * https://nodejs.org/api/buffer.html#class-file
          * @since v20.0.0
          */

node/child_process.d.ts

@@ -4,7 +4,7 @@
  * is primarily provided by the {@link spawn} function:
  *
  * ```js
- * const { spawn } = require('node:child_process');
+ * import { spawn } from 'node:child_process';
  * const ls = spawn('ls', ['-lh', '/usr']);
  *
  * ls.stdout.on('data', (data) => {
@@ -109,7 +109,7 @@ declare module "child_process" {
          * refer to the same value.
          *
          * ```js
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          *
          * const subprocess = spawn('ls');
          *
@@ -152,9 +152,9 @@ declare module "child_process" {
          * in the array are `null`.
          *
          * ```js
-         * const assert = require('node:assert');
-         * const fs = require('node:fs');
-         * const child_process = require('node:child_process');
+         * import assert from 'node:assert';
+         * import fs from 'node:fs';
+         * import child_process from 'node:child_process';
          *
          * const subprocess = child_process.spawn('ls', {
          *   stdio: [
@@ -202,7 +202,7 @@ declare module "child_process" {
          * emitted.
          *
          * ```js
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          * const grep = spawn('grep', ['ssh']);
          *
          * console.log(`Spawned child pid: ${grep.pid}`);
@@ -249,7 +249,7 @@ declare module "child_process" {
          * returns `true` if [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) succeeds, and `false` otherwise.
          *
          * ```js
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          * const grep = spawn('grep', ['ssh']);
          *
          * grep.on('close', (code, signal) => {
@@ -282,7 +282,7 @@ declare module "child_process" {
          *
          * ```js
          * 'use strict';
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          *
          * const subprocess = spawn(
          *   'sh',
@@ -320,7 +320,7 @@ declare module "child_process" {
          * For example, in the parent script:
          *
          * ```js
-         * const cp = require('node:child_process');
+         * import cp from 'node:child_process';
          * const n = cp.fork(`${__dirname}/sub.js`);
          *
          * n.on('message', (m) => {
@@ -374,10 +374,12 @@ declare module "child_process" {
          * a TCP server object to the child process as illustrated in the example below:
          *
          * ```js
-         * const subprocess = require('node: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.
-         * const server = require('node:net').createServer();
+         * const server = createServer();
          * server.on('connection', (socket) => {
          *   socket.end('handled by parent');
          * });
@@ -412,13 +414,14 @@ declare module "child_process" {
          * handle connections with "normal" or "special" priority:
          *
          * ```js
-         * const { fork } = require('node:child_process');
+         * 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.
-         * const server = require('node:net').createServer({ pauseOnConnect: true });
+         * const server = createServer({ pauseOnConnect: true });
          * server.on('connection', (socket) => {
          *
          *   // If this is special priority...
@@ -490,7 +493,7 @@ declare module "child_process" {
          * the child and the parent.
          *
          * ```js
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          *
          * const subprocess = spawn(process.argv[0], ['child_program.js'], {
          *   detached: true,
@@ -508,7 +511,7 @@ declare module "child_process" {
          * to wait for the child to exit before exiting itself.
          *
          * ```js
-         * const { spawn } = require('node:child_process');
+         * import { spawn } from 'node:child_process';
          *
          * const subprocess = spawn(process.argv[0], ['child_program.js'], {
          *   detached: true,
@@ -711,7 +714,7 @@ declare module "child_process" {
      * exit code:
      *
      * ```js
-     * const { spawn } = require('node:child_process');
+     * import { spawn } from 'node:child_process';
      * const ls = spawn('ls', ['-lh', '/usr']);
      *
      * ls.stdout.on('data', (data) => {
@@ -730,7 +733,7 @@ declare module "child_process" {
      * Example: A very elaborate way to run `ps ax | grep ssh`
      *
      * ```js
-     * const { spawn } = require('node:child_process');
+     * import { spawn } from 'node:child_process';
      * const ps = spawn('ps', ['ax']);
      * const grep = spawn('grep', ['ssh']);
      *
@@ -767,7 +770,7 @@ declare module "child_process" {
      * Example of checking for failed `spawn`:
      *
      * ```js
-     * const { spawn } = require('node:child_process');
+     * import { spawn } from 'node:child_process';
      * const subprocess = spawn('bad_command');
      *
      * subprocess.on('error', (err) => {
@@ -785,7 +788,7 @@ declare module "child_process" {
      * the error passed to the callback will be an `AbortError`:
      *
      * ```js
-     * const { spawn } = require('node:child_process');
+     * import { spawn } from 'node:child_process';
      * const controller = new AbortController();
      * const { signal } = controller;
      * const grep = spawn('grep', ['ssh'], { signal });
@@ -906,7 +909,7 @@ declare module "child_process" {
      * need to be dealt with accordingly:
      *
      * ```js
-     * const { exec } = require('node:child_process');
+     * import { exec } from 'node:child_process';
      *
      * exec('"/path/to/test file/test.sh" arg1 arg2');
      * // Double quotes are used so that the space in the path is not interpreted as
@@ -932,7 +935,7 @@ declare module "child_process" {
      * encoding, `Buffer` objects will be passed to the callback instead.
      *
      * ```js
-     * const { exec } = require('node:child_process');
+     * import { exec } from 'node:child_process';
      * exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => {
      *   if (error) {
      *     console.error(`exec error: ${error}`);
@@ -957,8 +960,9 @@ declare module "child_process" {
      * callback, but with two additional properties `stdout` and `stderr`.
      *
      * ```js
-     * const util = require('node:util');
-     * const exec = util.promisify(require('node:child_process').exec);
+     * import util from 'node:util';
+     * import child_process from 'node:child_process';
+     * const exec = util.promisify(child_process.exec);
      *
      * async function lsExample() {
      *   const { stdout, stderr } = await exec('ls');
@@ -972,7 +976,7 @@ declare module "child_process" {
      * the error passed to the callback will be an `AbortError`:
      *
      * ```js
-     * const { exec } = require('node:child_process');
+     * import { exec } from 'node:child_process';
      * const controller = new AbortController();
      * const { signal } = controller;
      * const child = exec('grep ssh', { signal }, (error) => {
@@ -1096,7 +1100,7 @@ declare module "child_process" {
      * supported.
      *
      * ```js
-     * const { execFile } = require('node:child_process');
+     * import { execFile } from 'node:child_process';
      * const child = execFile('node', ['--version'], (error, stdout, stderr) => {
      *   if (error) {
      *     throw error;
@@ -1119,8 +1123,9 @@ declare module "child_process" {
      * callback, but with two additional properties `stdout` and `stderr`.
      *
      * ```js
-     * const util = require('node:util');
-     * const execFile = util.promisify(require('node:child_process').execFile);
+     * import util from 'node:util';
+     * 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);
@@ -1136,7 +1141,7 @@ declare module "child_process" {
      * the error passed to the callback will be an `AbortError`:
      *
      * ```js
-     * const { execFile } = require('node:child_process');
+     * import { execFile } from 'node:child_process';
      * const controller = new AbortController();
      * const { signal } = controller;
      * const child = execFile('node', ['--version'], { signal }, (error) => {
@@ -1377,7 +1382,7 @@ declare module "child_process" {
      *     console.log(`Hello from ${process.argv[2]}!`);
      *   }, 1_000);
      * } else {
-     *   const { fork } = require('node:child_process');
+     *   import { fork } from 'node:child_process';
      *   const controller = new AbortController();
      *   const { signal } = controller;
      *   const child = fork(__filename, ['child'], { signal });

node/cluster.d.ts

@@ -231,6 +231,8 @@ declare module "cluster" {
          * the `'disconnect'` event has not been emitted after some time.
          *
          * ```js
+         * import net from 'node:net';
+         *
          * if (cluster.isPrimary) {
          *   const worker = cluster.fork();
          *   let timeout;
@@ -248,7 +250,6 @@ declare module "cluster" {
          *   });
          *
          * } else if (cluster.isWorker) {
-         *   const net = require('node:net');
          *   const server = net.createServer((socket) => {
          *     // Connections never end
          *   });

node/console.d.ts

@@ -6,7 +6,7 @@
  *
  * * 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-v22.x/api/process.html#processstdout) and
- * [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without calling `require('node:console')`.
+ * [`process.stderr`](https://nodejs.org/docs/latest-v22.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
@@ -362,7 +362,7 @@ declare module "node:console" {
          *
          * * 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-v22.x/api/process.html#processstdout) and
-         * [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without calling `require('console')`.
+         * [`process.stderr`](https://nodejs.org/docs/latest-v22.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

node/crypto.d.ts

@@ -3316,8 +3316,8 @@ declare module "crypto" {
      * Example:
      *
      * ```js
-     * const crypto = require('node:crypto');
-     * const { Buffer } = require('node:buffer');
+     * import crypto from 'node:crypto';
+     * import { Buffer } from 'node:buffer';
      *
      * // Hashing a string and return the result as a hex-encoded string.
      * const string = 'Node.js';
@@ -4034,7 +4034,7 @@ declare module "crypto" {
             saltLength: number;
         }
         /**
-         * Calling `require('node:crypto').webcrypto` returns an instance of the `Crypto` class.
+         * Importing the `webcrypto` object (`import { webcrypto } from 'node:crypto'`) gives an instance of the `Crypto` class.
          * `Crypto` is a singleton that provides access to the remainder of the crypto API.
          * @since v15.0.0
          */

node/dns/promises.d.ts

@@ -1,7 +1,7 @@
 /**
  * The `dns.promises` API provides an alternative set of asynchronous DNS methods
  * that return `Promise` objects rather than using callbacks. The API is accessible
- * via `require('node:dns').promises` or `require('node:dns/promises')`.
+ * via `import { promises as dnsPromises } from 'node:dns'` or `import dnsPromises from 'node:dns/promises'`.
  * @since v10.6.0
  */
 declare module "dns/promises" {
@@ -60,7 +60,7 @@ declare module "dns/promises" {
      * Example usage:
      *
      * ```js
-     * const dns = require('node:dns');
+     * import dns from 'node:dns';
      * const dnsPromises = dns.promises;
      * const options = {
      *   family: 6,
@@ -96,7 +96,7 @@ declare module "dns/promises" {
      * On error, the `Promise` is rejected with an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code` is the error code.
      *
      * ```js
-     * const dnsPromises = require('node:dns').promises;
+     * import dnsPromises from 'node:dns';
      * dnsPromises.lookupService('127.0.0.1', 22).then((result) => {
      *   console.log(result.hostname, result.service);
      *   // Prints: localhost ssh
@@ -394,8 +394,8 @@ declare module "dns/promises" {
      * other resolvers:
      *
      * ```js
-     * const { Resolver } = require('node:dns').promises;
-     * const resolver = new Resolver();
+     * import { promises } from 'node:dns';
+     * const resolver = new promises.Resolver();
      * resolver.setServers(['4.4.4.4']);
      *
      * // This request will use the server at 4.4.4.4, independent of global settings.

node/dns.d.ts

@@ -9,7 +9,7 @@
  * system do, use {@link lookup}.
  *
  * ```js
- * const dns = require('node:dns');
+ * import dns from 'node:dns';
  *
  * dns.lookup('example.org', (err, address, family) => {
  *   console.log('address: %j family: IPv%s', address, family);
@@ -23,7 +23,7 @@
  * DNS queries, bypassing other name-resolution facilities.
  *
  * ```js
- * const dns = require('node:dns');
+ * import dns from 'node:dns';
  *
  * dns.resolve4('archive.org', (err, addresses) => {
  *   if (err) throw err;
@@ -139,7 +139,7 @@ declare module "dns" {
      * Example usage:
      *
      * ```js
-     * const dns = require('node:dns');
+     * import dns from 'node:dns';
      * const options = {
      *   family: 6,
      *   hints: dns.ADDRCONFIG | dns.V4MAPPED,
@@ -199,7 +199,7 @@ declare module "dns" {
      * where `err.code` is the error code.
      *
      * ```js
-     * const dns = require('node:dns');
+     * import dns from 'node:dns';
      * dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
      *   console.log(hostname, service);
      *   // Prints: localhost ssh
@@ -787,7 +787,7 @@ declare module "dns" {
      * other resolvers:
      *
      * ```js
-     * const { Resolver } = require('node:dns');
+     * import { Resolver } from 'node:dns';
      * const resolver = new Resolver();
      * resolver.setServers(['4.4.4.4']);
      *

node/domain.d.ts

@@ -63,8 +63,8 @@ declare module "domain" {
          * This is the most basic way to use a domain.
          *
          * ```js
-         * const domain = require('node:domain');
-         * const fs = require('node:fs');
+         * import domain from 'node:domain';
+         * import fs from 'node:fs';
          * const d = domain.create();
          * d.on('error', (er) => {
          *   console.error('Caught error!', er);

node/fs/promises.d.ts

@@ -932,7 +932,7 @@ declare module "fs/promises" {
      * The `fsPromises.mkdtemp()` method will append the six randomly selected
      * characters directly to the `prefix` string. For instance, given a directory `/tmp`, if the intention is to create a temporary directory _within_ `/tmp`, the `prefix` must end with a trailing
      * platform-specific path separator
-     * (`require('node:path').sep`).
+     * (`import { sep } from 'node:path'`).
      * @since v10.0.0
      * @return Fulfills with a string containing the file system path of the newly created temporary directory.
      */
@@ -1174,7 +1174,7 @@ declare module "fs/promises" {
      * Returns an async iterator that watches for changes on `filename`, where `filename`is either a file or a directory.
      *
      * ```js
-     * const { watch } = require('node:fs/promises');
+     * import { watch } from 'node:fs/promises';
      *
      * const ac = new AbortController();
      * const { signal } = ac;

node/fs.d.ts

@@ -1900,7 +1900,7 @@ declare module "fs" {
      * The `fs.mkdtemp()` method will append the six randomly selected characters
      * directly to the `prefix` string. For instance, given a directory `/tmp`, if the
      * intention is to create a temporary directory _within_`/tmp`, the `prefix`must end with a trailing platform-specific path separator
-     * (`require('node:path').sep`).
+     * (`import { sep } from 'node:path'`).
      *
      * ```js
      * import { tmpdir } from 'node:os';
@@ -3156,7 +3156,7 @@ declare module "fs" {
      * stat object:
      *
      * ```js
-     * import { watchFile } from 'fs';
+     * import { watchFile } from 'node:fs';
      *
      * watchFile('message.text', (curr, prev) => {
      *   console.log(`the current mtime is: ${curr.mtime}`);

node/http.d.ts

@@ -1,5 +1,5 @@
 /**
- * To use the HTTP server and client one must `require('node:http')`.
+ * To use the HTTP server and client one must import the `node:http` module.
  *
  * The HTTP interfaces in Node.js are designed to support many features
  * of the protocol which have been traditionally difficult to use.
@@ -1447,7 +1447,7 @@ declare module "http" {
      * To configure any of them, a custom {@link Agent} instance must be created.
      *
      * ```js
-     * const http = require('node:http');
+     * import http from 'node:http';
      * const keepAliveAgent = new http.Agent({ keepAlive: true });
      * options.agent = keepAliveAgent;
      * http.request(options, onResponseCallback)