@types/node 22.15.21 → 22.18.10

node v22.18/README.md

@@ -0,0 +1,15 @@
+# Installation
+> `npm install --save @types/node`
+
+# Summary
+This package contains type definitions for node (https://nodejs.org/).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v22.
+
+### Additional Details
+ * Last updated: Sat, 11 Oct 2025 14:02:18 GMT
+ * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
+
+# Credits
+These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [Alberto Schiabel](https://github.com/jkomyno), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [David Junger](https://github.com/touffy), [Mohsen Azimi](https://github.com/mohsen1), [Nikita Galkin](https://github.com/galkin), [Sebastian Silbermann](https://github.com/eps1lon), [Wilco Bakker](https://github.com/WilcoBakker), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Victor Perin](https://github.com/victorperin), [NodeJS Contributors](https://github.com/NodeJS), [Linus Unnebäck](https://github.com/LinusU), [wafuwafu13](https://github.com/wafuwafu13), [Matteo Collina](https://github.com/mcollina), [Dmitry Semigradsky](https://github.com/Semigradsky), and [René](https://github.com/Renegade334).

node/assert.d.ts → node v22.18/assert.d.ts

@@ -11,6 +11,25 @@ declare module "assert" {
      */
     function assert(value: unknown, message?: string | Error): asserts value;
     namespace assert {
+        type AssertMethodNames =
+            | "deepEqual"
+            | "deepStrictEqual"
+            | "doesNotMatch"
+            | "doesNotReject"
+            | "doesNotThrow"
+            | "equal"
+            | "fail"
+            | "ifError"
+            | "match"
+            | "notDeepEqual"
+            | "notDeepStrictEqual"
+            | "notEqual"
+            | "notStrictEqual"
+            | "ok"
+            | "partialDeepStrictEqual"
+            | "rejects"
+            | "strictEqual"
+            | "throws";
         /**
          * Indicates the failure of an assertion. All errors thrown by the `node:assert` module will be instances of the `AssertionError` class.
          */

node/buffer.d.ts → node v22.18/buffer.d.ts

@@ -118,7 +118,6 @@ declare module "buffer" {
      * Resolves a `'blob:nodedata:...'` an associated `Blob` object registered using
      * a prior call to `URL.createObjectURL()`.
      * @since v16.7.0
-     * @experimental
      * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
      */
     export function resolveObjectURL(id: string): Blob | undefined;
@@ -140,7 +139,7 @@ declare module "buffer" {
         type?: string | undefined;
     }
     /**
-     * A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates immutable, raw data that can be safely shared across
+     * A `Blob` encapsulates immutable, raw data that can be safely shared across
      * multiple worker threads.
      * @since v15.7.0, v14.18.0
      */
@@ -1702,6 +1701,8 @@ declare module "buffer" {
              * @return A reference to `buf`.
              */
             fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this;
+            fill(value: string | Uint8Array | number, offset: number, encoding: BufferEncoding): this;
+            fill(value: string | Uint8Array | number, encoding: BufferEncoding): this;
             /**
              * If `value` is:
              *
@@ -1771,6 +1772,7 @@ declare module "buffer" {
              * @return The index of the first occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`.
              */
             indexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+            indexOf(value: string | number | Uint8Array, encoding: BufferEncoding): number;
             /**
              * Identical to `buf.indexOf()`, except the last occurrence of `value` is found
              * rather than the first occurrence.
@@ -1839,6 +1841,7 @@ declare module "buffer" {
              * @return The index of the last occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`.
              */
             lastIndexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+            lastIndexOf(value: string | number | Uint8Array, encoding: BufferEncoding): number;
             /**
              * Equivalent to `buf.indexOf() !== -1`.
              *
@@ -1869,6 +1872,7 @@ declare module "buffer" {
              * @return `true` if `value` was found in `buf`, `false` otherwise.
              */
             includes(value: string | number | Buffer, byteOffset?: number, encoding?: BufferEncoding): boolean;
+            includes(value: string | number | Buffer, encoding: BufferEncoding): boolean;
         }
         var Buffer: BufferConstructor;
         /**

node/child_process.d.ts → node v22.18/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
@@ -66,11 +66,10 @@
  * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/child_process.js)
  */
 declare module "child_process" {
-    import { ObjectEncodingOptions } from "node:fs";
     import { Abortable, EventEmitter } from "node:events";
     import * as dgram from "node:dgram";
     import * as net from "node:net";
-    import { Pipe, Readable, Stream, Writable } from "node:stream";
+    import { Readable, Stream, Writable } from "node:stream";
     import { URL } from "node:url";
     type Serializable = string | object | number | boolean | bigint;
     type SendHandle = net.Socket | net.Server | dgram.Socket | undefined;
@@ -140,7 +139,7 @@ declare module "child_process" {
          * no IPC channel exists, this property is `undefined`.
          * @since v7.1.0
          */
-        readonly channel?: Pipe | null | undefined;
+        readonly channel?: Control | null;
         /**
          * A sparse array of pipes to the child process, corresponding with positions in
          * the `stdio` option passed to {@link spawn} that have been set
@@ -613,6 +612,10 @@ declare module "child_process" {
             Readable | Writable | null | undefined, // extra, no modification
         ];
     }
+    interface Control extends EventEmitter {
+        ref(): void;
+        unref(): void;
+    }
     interface MessageOptions {
         keepOpen?: boolean | undefined;
     }
@@ -887,18 +890,20 @@ declare module "child_process" {
         signal?: AbortSignal | undefined;
         maxBuffer?: number | undefined;
         killSignal?: NodeJS.Signals | number | undefined;
+        encoding?: string | null | undefined;
     }
     interface ExecOptionsWithStringEncoding extends ExecOptions {
-        encoding: BufferEncoding;
+        encoding?: BufferEncoding | undefined;
     }
     interface ExecOptionsWithBufferEncoding extends ExecOptions {
-        encoding: BufferEncoding | null; // specify `null`.
+        encoding: "buffer" | null; // specify `null`.
     }
+    // TODO: Just Plain Wrong™ (see also nodejs/node#57392)
     interface ExecException extends Error {
-        cmd?: string | undefined;
-        killed?: boolean | undefined;
-        code?: number | undefined;
-        signal?: NodeJS.Signals | undefined;
+        cmd?: string;
+        killed?: boolean;
+        code?: number;
+        signal?: NodeJS.Signals;
         stdout?: string;
         stderr?: string;
     }
@@ -995,38 +1000,19 @@ declare module "child_process" {
     // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
     function exec(
         command: string,
-        options: {
-            encoding: "buffer" | null;
-        } & ExecOptions,
+        options: ExecOptionsWithBufferEncoding,
         callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void,
     ): ChildProcess;
-    // `options` with well known `encoding` means stdout/stderr are definitely `string`.
+    // `options` with well-known or absent `encoding` means stdout/stderr are definitely `string`.
     function exec(
         command: string,
-        options: {
-            encoding: BufferEncoding;
-        } & ExecOptions,
-        callback?: (error: ExecException | null, stdout: string, stderr: string) => void,
-    ): ChildProcess;
-    // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
-    // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
-    function exec(
-        command: string,
-        options: {
-            encoding: BufferEncoding;
-        } & ExecOptions,
-        callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
-    ): ChildProcess;
-    // `options` without an `encoding` means stdout/stderr are definitely `string`.
-    function exec(
-        command: string,
-        options: ExecOptions,
+        options: ExecOptionsWithStringEncoding,
         callback?: (error: ExecException | null, stdout: string, stderr: string) => void,
     ): ChildProcess;
     // fallback if nothing else matches. Worst case is always `string | Buffer`.
     function exec(
         command: string,
-        options: (ObjectEncodingOptions & ExecOptions) | undefined | null,
+        options: ExecOptions | undefined | null,
         callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
     ): ChildProcess;
     interface PromiseWithChild<T> extends Promise<T> {
@@ -1039,32 +1025,21 @@ declare module "child_process" {
         }>;
         function __promisify__(
             command: string,
-            options: {
-                encoding: "buffer" | null;
-            } & ExecOptions,
+            options: ExecOptionsWithBufferEncoding,
         ): PromiseWithChild<{
             stdout: Buffer;
             stderr: Buffer;
         }>;
         function __promisify__(
             command: string,
-            options: {
-                encoding: BufferEncoding;
-            } & ExecOptions,
-        ): PromiseWithChild<{
-            stdout: string;
-            stderr: string;
-        }>;
-        function __promisify__(
-            command: string,
-            options: ExecOptions,
+            options: ExecOptionsWithStringEncoding,
         ): PromiseWithChild<{
             stdout: string;
             stderr: string;
         }>;
         function __promisify__(
             command: string,
-            options?: (ObjectEncodingOptions & ExecOptions) | null,
+            options: ExecOptions | undefined | null,
         ): PromiseWithChild<{
             stdout: string | Buffer;
             stderr: string | Buffer;
@@ -1076,20 +1051,21 @@ declare module "child_process" {
         windowsVerbatimArguments?: boolean | undefined;
         shell?: boolean | string | undefined;
         signal?: AbortSignal | undefined;
+        encoding?: string | null | undefined;
     }
     interface ExecFileOptionsWithStringEncoding extends ExecFileOptions {
-        encoding: BufferEncoding;
+        encoding?: BufferEncoding | undefined;
     }
     interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions {
         encoding: "buffer" | null;
     }
-    interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions {
-        encoding: BufferEncoding;
-    }
+    /** @deprecated Use `ExecFileOptions` instead. */
+    interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions {}
+    // TODO: execFile exceptions can take many forms... this accurately describes none of them
     type ExecFileException =
         & Omit<ExecException, "code">
         & Omit<NodeJS.ErrnoException, "code">
-        & { code?: string | number | undefined | null };
+        & { code?: string | number | null };
     /**
      * The `child_process.execFile()` function is similar to {@link exec} except that it does not spawn a shell by default. Rather, the specified
      * executable `file` is spawned directly as a new process making it slightly more
@@ -1154,80 +1130,44 @@ declare module "child_process" {
      * @param args List of string arguments.
      * @param callback Called with the output when process terminates.
      */
-    function execFile(file: string): ChildProcess;
-    function execFile(
-        file: string,
-        options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
-    ): ChildProcess;
-    function execFile(file: string, args?: readonly string[] | null): ChildProcess;
-    function execFile(
-        file: string,
-        args: readonly string[] | undefined | null,
-        options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
-    ): ChildProcess;
     // no `options` definitely means stdout/stderr are `string`.
     function execFile(
         file: string,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
+        callback?: (error: ExecFileException | null, stdout: string, stderr: string) => void,
     ): ChildProcess;
     function execFile(
         file: string,
         args: readonly string[] | undefined | null,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
+        callback?: (error: ExecFileException | null, stdout: string, stderr: string) => void,
     ): ChildProcess;
     // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
     function execFile(
         file: string,
         options: ExecFileOptionsWithBufferEncoding,
-        callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
+        callback?: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
     ): ChildProcess;
     function execFile(
         file: string,
         args: readonly string[] | undefined | null,
         options: ExecFileOptionsWithBufferEncoding,
-        callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
+        callback?: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
     ): ChildProcess;
-    // `options` with well known `encoding` means stdout/stderr are definitely `string`.
+    // `options` with well-known or absent `encoding` means stdout/stderr are definitely `string`.
     function execFile(
         file: string,
         options: ExecFileOptionsWithStringEncoding,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
+        callback?: (error: ExecFileException | null, stdout: string, stderr: string) => void,
     ): ChildProcess;
     function execFile(
         file: string,
         args: readonly string[] | undefined | null,
         options: ExecFileOptionsWithStringEncoding,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
-    ): ChildProcess;
-    // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
-    // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
-    function execFile(
-        file: string,
-        options: ExecFileOptionsWithOtherEncoding,
-        callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
-    ): ChildProcess;
-    function execFile(
-        file: string,
-        args: readonly string[] | undefined | null,
-        options: ExecFileOptionsWithOtherEncoding,
-        callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
-    ): ChildProcess;
-    // `options` without an `encoding` means stdout/stderr are definitely `string`.
-    function execFile(
-        file: string,
-        options: ExecFileOptions,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
-    ): ChildProcess;
-    function execFile(
-        file: string,
-        args: readonly string[] | undefined | null,
-        options: ExecFileOptions,
-        callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
+        callback?: (error: ExecFileException | null, stdout: string, stderr: string) => void,
     ): ChildProcess;
     // fallback if nothing else matches. Worst case is always `string | Buffer`.
     function execFile(
         file: string,
-        options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+        options: ExecFileOptions | undefined | null,
         callback:
             | ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void)
             | undefined
@@ -1236,7 +1176,7 @@ declare module "child_process" {
     function execFile(
         file: string,
         args: readonly string[] | undefined | null,
-        options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+        options: ExecFileOptions | undefined | null,
         callback:
             | ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void)
             | undefined
@@ -1286,37 +1226,7 @@ declare module "child_process" {
         }>;
         function __promisify__(
             file: string,
-            options: ExecFileOptionsWithOtherEncoding,
-        ): PromiseWithChild<{
-            stdout: string | Buffer;
-            stderr: string | Buffer;
-        }>;
-        function __promisify__(
-            file: string,
-            args: readonly string[] | undefined | null,
-            options: ExecFileOptionsWithOtherEncoding,
-        ): PromiseWithChild<{
-            stdout: string | Buffer;
-            stderr: string | Buffer;
-        }>;
-        function __promisify__(
-            file: string,
-            options: ExecFileOptions,
-        ): PromiseWithChild<{
-            stdout: string;
-            stderr: string;
-        }>;
-        function __promisify__(
-            file: string,
-            args: readonly string[] | undefined | null,
-            options: ExecFileOptions,
-        ): PromiseWithChild<{
-            stdout: string;
-            stderr: string;
-        }>;
-        function __promisify__(
-            file: string,
-            options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+            options: ExecFileOptions | undefined | null,
         ): PromiseWithChild<{
             stdout: string | Buffer;
             stderr: string | Buffer;
@@ -1324,7 +1234,7 @@ declare module "child_process" {
         function __promisify__(
             file: string,
             args: readonly string[] | undefined | null,
-            options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+            options: ExecFileOptions | undefined | null,
         ): PromiseWithChild<{
             stdout: string | Buffer;
             stderr: string | Buffer;
@@ -1416,7 +1326,7 @@ declare module "child_process" {
         stderr: T;
         status: number | null;
         signal: NodeJS.Signals | null;
-        error?: Error | undefined;
+        error?: Error;
     }
     /**
      * The `child_process.spawnSync()` method is generally identical to {@link spawn} with the exception that the function will not return
@@ -1505,7 +1415,7 @@ declare module "child_process" {
         encoding: BufferEncoding;
     }
     interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions {
-        encoding?: "buffer" | null; // specify `null`.
+        encoding?: "buffer" | null | undefined; // specify `null`.
     }
     /**
      * The `child_process.execFileSync()` method is generally identical to {@link execFile} with the exception that the method will not

node/cluster.d.ts → node v22.18/cluster.d.ts

@@ -481,7 +481,7 @@ declare module "cluster" {
          * ```
          * @since v0.7.0
          */
-        readonly worker?: Worker | undefined;
+        readonly worker?: Worker;
         /**
          * A hash that stores the active worker objects, keyed by `id` field. This makes it easy to loop through all the workers. It is only available in the primary process.
          *
@@ -497,7 +497,7 @@ declare module "cluster" {
          * ```
          * @since v0.7.0
          */
-        readonly workers?: NodeJS.Dict<Worker> | undefined;
+        readonly workers?: NodeJS.Dict<Worker>;
         readonly SCHED_NONE: number;
         readonly SCHED_RR: number;
         /**
@@ -550,10 +550,9 @@ declare module "cluster" {
         prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
         prependListener(event: "fork", listener: (worker: Worker) => void): this;
         prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
-        // the handle is a net.Socket or net.Server object, or undefined.
         prependListener(
             event: "message",
-            listener: (worker: Worker, message: any, handle?: net.Socket | net.Server) => void,
+            listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
         ): this;
         prependListener(event: "online", listener: (worker: Worker) => void): this;
         prependListener(event: "setup", listener: (settings: ClusterSettings) => void): this;

node/compatibility/disposable.d.ts → node v22.18/compatibility/disposable.d.ts

@@ -1,6 +1,4 @@
 // Polyfills for the explicit resource management types added in TypeScript 5.2.
-// TODO: remove once this package no longer supports TS 5.1, and replace with a
-// <reference> to TypeScript's disposable library in index.d.ts.
 
 interface SymbolConstructor {
     readonly dispose: unique symbol;

node/compatibility/indexable.d.ts → node v22.18/compatibility/indexable.d.ts

@@ -1,7 +1,4 @@
 // Polyfill for ES2022's .at() method on string/array prototypes, added to TypeScript in 4.6.
-// TODO: these methods are not used within @types/node, and should be removed at the next
-// major @types/node version; users should include the es2022 TypeScript libraries
-// if they need these features.
 
 interface RelativeIndexable<T> {
     at(index: number): T | undefined;

node/compatibility/iterators.d.ts → node v22.18/compatibility/iterators.d.ts

@@ -3,7 +3,6 @@
 // are expected (eg. DOM-compatible APIs) if lib.esnext.iterator is loaded.
 // Also ensures that iterators returned by the Node API, which inherit from Iterator.prototype, correctly expose the iterator helper methods
 // if lib.esnext.iterator is loaded.
-// TODO: remove once this package no longer supports TS 5.5, and replace NodeJS.BuiltinIteratorReturn with BuiltinIteratorReturn.
 
 // Placeholders for TS <5.6
 interface IteratorObject<T, TReturn, TNext> {}