@types/node 24.7.1 → 24.8.0

node/perf_hooks.d.ts

@@ -48,13 +48,13 @@ declare module "perf_hooks" {
          * the type of garbage collection operation that occurred.
          * See perf_hooks.constants for valid values.
          */
-        readonly kind?: number | undefined;
+        readonly kind: number;
         /**
          * When `performanceEntry.entryType` is equal to 'gc', the `performance.flags`
          * property contains additional information about garbage collection operation.
          * See perf_hooks.constants for valid values.
          */
-        readonly flags?: number | undefined;
+        readonly flags: number;
     }
     /**
      * The constructor of this class is not exposed to users directly.
@@ -92,11 +92,6 @@ declare module "perf_hooks" {
          * @since v8.5.0
          */
         readonly entryType: EntryType;
-        /**
-         * Additional detail specific to the `entryType`.
-         * @since v16.0.0
-         */
-        readonly detail?: NodeGCPerformanceDetail | unknown | undefined; // TODO: Narrow this based on entry type.
         toJSON(): any;
     }
     /**
@@ -104,6 +99,7 @@ declare module "perf_hooks" {
      * @since v18.2.0, v16.17.0
      */
     class PerformanceMark extends PerformanceEntry {
+        readonly detail: any;
         readonly duration: 0;
         readonly entryType: "mark";
     }
@@ -114,6 +110,7 @@ declare module "perf_hooks" {
      * @since v18.2.0, v16.17.0
      */
     class PerformanceMeasure extends PerformanceEntry {
+        readonly detail: any;
         readonly entryType: "measure";
     }
     interface UVMetrics {
@@ -130,6 +127,7 @@ declare module "perf_hooks" {
          */
         readonly eventsWaiting: number;
     }
+    // TODO: PerformanceNodeEntry is missing
     /**
      * _This property is an extension by Node.js. It is not available in Web browsers._
      *
@@ -225,7 +223,7 @@ declare module "perf_hooks" {
         /**
          * Additional optional detail to include with the mark.
          */
-        detail?: unknown | undefined;
+        detail?: unknown;
         /**
          * Duration between start and end times.
          */

node/process.d.ts

@@ -1,4 +1,5 @@
 declare module "process" {
+    import { Control, MessageOptions } from "node:child_process";
     import * as tty from "node:tty";
     import { Worker } from "node:worker_threads";
 
@@ -346,7 +347,7 @@ declare module "process" {
                 /**
                  * Can be used to change the default timezone at runtime
                  */
-                TZ?: string;
+                TZ?: string | undefined;
             }
             interface HRTime {
                 /**
@@ -990,7 +991,7 @@ declare module "process" {
                  * @since v0.1.13
                  * @param [code=0] The exit code. For string type, only integer strings (e.g.,'1') are allowed.
                  */
-                exit(code?: number | string | null | undefined): never;
+                exit(code?: number | string | null): never;
                 /**
                  * A number which will be the process exit code, when the process either
                  * exits gracefully, or is exited via {@link exit} without specifying
@@ -1001,7 +1002,7 @@ declare module "process" {
                  * @default undefined
                  * @since v0.11.8
                  */
-                exitCode?: number | string | number | undefined;
+                exitCode: number | string | null | undefined;
                 finalization: {
                     /**
                      * This function registers a callback to be called when the process emits the `exit` event if the `ref` object was not garbage collected.
@@ -1568,7 +1569,7 @@ declare module "process" {
                  * @since v0.1.17
                  * @deprecated Since v14.0.0 - Use `main` instead.
                  */
-                mainModule?: Module | undefined;
+                mainModule?: Module;
                 memoryUsage: MemoryUsageFn;
                 /**
                  * Gets the amount of memory available to the process (in bytes) based on
@@ -1760,18 +1761,7 @@ declare module "process" {
                  * If no IPC channel exists, this property is undefined.
                  * @since v7.1.0
                  */
-                channel?: {
-                    /**
-                     * This method makes the IPC channel keep the event loop of the process running if .unref() has been called before.
-                     * @since v7.1.0
-                     */
-                    ref(): void;
-                    /**
-                     * This method makes the IPC channel not keep the event loop of the process running, and lets it finish even while the channel is open.
-                     * @since v7.1.0
-                     */
-                    unref(): void;
-                };
+                channel?: Control;
                 /**
                  * If Node.js is spawned with an IPC channel, the `process.send()` method can be
                  * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object.
@@ -1786,9 +1776,7 @@ declare module "process" {
                 send?(
                     message: any,
                     sendHandle?: any,
-                    options?: {
-                        keepOpen?: boolean | undefined;
-                    },
+                    options?: MessageOptions,
                     callback?: (error: Error | null) => void,
                 ): boolean;
                 /**

node/readline/promises.d.ts

@@ -64,7 +64,7 @@ declare module "readline/promises" {
         constructor(
             stream: NodeJS.WritableStream,
             options?: {
-                autoCommit?: boolean;
+                autoCommit?: boolean | undefined;
             },
         );
         /**

node/sea.d.ts

@@ -150,4 +150,13 @@ declare module "node:sea" {
      * @since v20.12.0
      */
     function getRawAsset(key: AssetKey): ArrayBuffer;
+    /**
+     * This method can be used to retrieve an array of all the keys of assets
+     * embedded into the single-executable application.
+     * An error is thrown when not running inside a single-executable application.
+     * @since v24.8.0
+     * @returns An array containing all the keys of the assets
+     * embedded in the executable. If no assets are embedded, returns an empty array.
+     */
+    function getAssetKeys(): string[];
 }

node/stream.d.ts

@@ -45,22 +45,22 @@ declare module "stream" {
             emitClose?: boolean | undefined;
             highWaterMark?: number | undefined;
             objectMode?: boolean | undefined;
-            construct?(this: T, callback: (error?: Error | null) => void): void;
-            destroy?(this: T, error: Error | null, callback: (error?: Error | null) => void): void;
+            construct?: ((this: T, callback: (error?: Error | null) => void) => void) | undefined;
+            destroy?: ((this: T, error: Error | null, callback: (error?: Error | null) => void) => void) | undefined;
             autoDestroy?: boolean | undefined;
         }
         interface ReadableOptions<T extends Readable = Readable> extends StreamOptions<T> {
             encoding?: BufferEncoding | undefined;
-            read?(this: T, size: number): void;
+            read?: ((this: T, size: number) => void) | undefined;
         }
         interface ArrayOptions {
             /**
              * The maximum concurrent invocations of `fn` to call on the stream at once.
              * @default 1
              */
-            concurrency?: number;
+            concurrency?: number | undefined;
             /** Allows destroying the stream if the signal is aborted. */
-            signal?: AbortSignal;
+            signal?: AbortSignal | undefined;
         }
         /**
          * @since v0.9.4
@@ -697,21 +697,25 @@ declare module "stream" {
         interface WritableOptions<T extends Writable = Writable> extends StreamOptions<T> {
             decodeStrings?: boolean | undefined;
             defaultEncoding?: BufferEncoding | undefined;
-            write?(
-                this: T,
-                chunk: any,
-                encoding: BufferEncoding,
-                callback: (error?: Error | null) => void,
-            ): void;
-            writev?(
-                this: T,
-                chunks: Array<{
-                    chunk: any;
-                    encoding: BufferEncoding;
-                }>,
-                callback: (error?: Error | null) => void,
-            ): void;
-            final?(this: T, callback: (error?: Error | null) => void): void;
+            write?:
+                | ((
+                    this: T,
+                    chunk: any,
+                    encoding: BufferEncoding,
+                    callback: (error?: Error | null) => void,
+                ) => void)
+                | undefined;
+            writev?:
+                | ((
+                    this: T,
+                    chunks: Array<{
+                        chunk: any;
+                        encoding: BufferEncoding;
+                    }>,
+                    callback: (error?: Error | null) => void,
+                ) => void)
+                | undefined;
+            final?: ((this: T, callback: (error?: Error | null) => void) => void) | undefined;
         }
         /**
          * @since v0.9.4
@@ -1235,8 +1239,10 @@ declare module "stream" {
         function duplexPair(options?: DuplexOptions): [Duplex, Duplex];
         type TransformCallback = (error?: Error | null, data?: any) => void;
         interface TransformOptions<T extends Transform = Transform> extends DuplexOptions<T> {
-            transform?(this: T, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
-            flush?(this: T, callback: TransformCallback): void;
+            transform?:
+                | ((this: T, chunk: any, encoding: BufferEncoding, callback: TransformCallback) => void)
+                | undefined;
+            flush?: ((this: T, callback: TransformCallback) => void) | undefined;
         }
         /**
          * Transform streams are `Duplex` streams where the output is in some way
@@ -1643,12 +1649,14 @@ declare module "stream" {
                 ...streams: Array<NodeJS.ReadWriteStream | NodeJS.WritableStream | PipelineOptions>
             ): Promise<void>;
         }
+        // TODO: this interface never existed; remove in next major
         interface Pipe {
             close(): void;
             hasRef(): boolean;
             ref(): void;
             unref(): void;
         }
+        // TODO: these should all take webstream arguments
         /**
          * Returns whether the stream has encountered an error.
          * @since v17.3.0, v16.14.0
@@ -1657,8 +1665,15 @@ declare module "stream" {
         /**
          * Returns whether the stream is readable.
          * @since v17.4.0, v16.14.0
+         * @returns Only returns `null` if `stream` is not a valid `Readable`, `Duplex` or `ReadableStream`.
+         */
+        function isReadable(stream: Readable | NodeJS.ReadableStream): boolean | null;
+        /**
+         * Returns whether the stream is writable.
+         * @since v20.0.0
+         * @returns Only returns `null` if `stream` is not a valid `Writable`, `Duplex` or `WritableStream`.
          */
-        function isReadable(stream: Readable | NodeJS.ReadableStream): boolean;
+        function isWritable(stream: Writable | NodeJS.WritableStream): boolean | null;
     }
     export = Stream;
 }

node/tls.d.ts

@@ -586,7 +586,7 @@ declare module "tls" {
          * requires explicitly specifying a cipher suite with the `ciphers` option.
          * More information can be found in the RFC 4279.
          */
-        pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null;
+        pskCallback?: ((socket: TLSSocket, identity: string) => NodeJS.ArrayBufferView | null) | undefined;
         /**
          * hint to send to a client to help
          * with selecting the identity during TLS-PSK negotiation. Will be ignored
@@ -627,7 +627,7 @@ declare module "tls" {
          * compatible with the selected cipher's digest.
          * `identity` must use UTF-8 encoding.
          */
-        pskCallback?(hint: string | null): PSKCallbackNegotation | null;
+        pskCallback?: ((hint: string | null) => PSKCallbackNegotation | null) | undefined;
     }
     /**
      * Accepts encrypted connections using TLS or SSL.

node/v8.d.ts

@@ -43,12 +43,12 @@ declare module "v8" {
          * If true, expose internals in the heap snapshot.
          * @default false
          */
-        exposeInternals?: boolean;
+        exposeInternals?: boolean | undefined;
         /**
          * If true, expose numeric values in artificial fields.
          * @default false
          */
-        exposeNumericValues?: boolean;
+        exposeNumericValues?: boolean | undefined;
     }
     /**
      * Returns an integer representing a version tag derived from the V8 version,
@@ -400,6 +400,22 @@ declare module "v8" {
      * @since v12.8.0
      */
     function getHeapCodeStatistics(): HeapCodeStatistics;
+    /**
+     * @since v24.8.0
+     */
+    interface CPUProfileHandle {
+        /**
+         * Stopping collecting the profile, then return a Promise that fulfills with an error or the
+         * profile data.
+         * @since v24.8.0
+         */
+        stop(): Promise<string>;
+        /**
+         * Stopping collecting the profile and the profile will be discarded.
+         * @since v24.8.0
+         */
+        [Symbol.asyncDispose](): Promise<void>;
+    }
     /**
      * V8 only supports `Latin-1/ISO-8859-1` and `UTF16` as the underlying representation of a string.
      * If the `content` uses `Latin-1/ISO-8859-1` as the underlying representation, this function will return true;