@types/node 20.17.28 → 20.17.29

node v20.17/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/v20.
 
 ### Additional Details
- * Last updated: Thu, 27 Mar 2025 03:13:14 GMT
+ * Last updated: Tue, 01 Apr 2025 05:35:48 GMT
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
 
 # Credits

node v20.17/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "20.17.28",
+    "version": "20.17.29",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -215,6 +215,6 @@
         "undici-types": "~6.19.2"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "0e6e31fc35f69eb67f9b49e14e070a90616484c787f902edc4ef687f2777f872",
-    "typeScriptVersion": "5.0"
+    "typesPublisherContentHash": "8248e4cc4e60b7fe2565f3ad85e8d17274e28fed2285442b0c1004b73a86fac9",
+    "typeScriptVersion": "5.1"
 }

node v20.17/timers/promises.d.ts

@@ -1,15 +1,17 @@
 /**
  * The `timers/promises` API provides an alternative set of timer functions
- * that return `Promise` objects. The API is accessible via `import timersPromises from 'node:timers/promises'`.
+ * that return `Promise` objects. The API is accessible via
+ * `require('node:timers/promises')`.
  *
  * ```js
  * import {
  *   setTimeout,
  *   setImmediate,
  *   setInterval,
- * } from 'timers/promises';
+ * } from 'node:timers/promises';
  * ```
  * @since v15.0.0
+ * @see [source](https://github.com/nodejs/node/blob/v20.x/lib/timers/promises.js)
  */
 declare module "timers/promises" {
     import { TimerOptions } from "node:timers";
@@ -17,14 +19,15 @@ declare module "timers/promises" {
      * ```js
      * import {
      *   setTimeout,
-     * } from 'timers/promises';
+     * } from 'node:timers/promises';
      *
      * const res = await setTimeout(100, 'result');
      *
      * console.log(res);  // Prints 'result'
      * ```
      * @since v15.0.0
-     * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
+     * @param delay The number of milliseconds to wait before fulfilling the
+     * promise. **Default:** `1`.
      * @param value A value with which the promise is fulfilled.
      */
     function setTimeout<T = void>(delay?: number, value?: T, options?: TimerOptions): Promise<T>;
@@ -32,7 +35,7 @@ declare module "timers/promises" {
      * ```js
      * import {
      *   setImmediate,
-     * } from 'timers/promises';
+     * } from 'node:timers/promises';
      *
      * const res = await setImmediate('result');
      *
@@ -50,7 +53,7 @@ declare module "timers/promises" {
      * ```js
      * import {
      *   setInterval,
-     * } from 'timers/promises';
+     * } from 'node:timers/promises';
      *
      * const interval = 100;
      * for await (const startTime of setInterval(interval, Date.now())) {
@@ -62,33 +65,41 @@ declare module "timers/promises" {
      * console.log(Date.now());
      * ```
      * @since v15.9.0
+     * @param delay The number of milliseconds to wait between iterations.
+     * **Default:** `1`.
+     * @param value A value with which the iterator returns.
      */
-    function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
+    function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): NodeJS.AsyncIterator<T>;
     interface Scheduler {
         /**
-         * An experimental API defined by the [Scheduling APIs](https://github.com/WICG/scheduling-apis) draft specification being developed as a standard Web Platform API.
+         * An experimental API defined by the [Scheduling APIs](https://github.com/WICG/scheduling-apis) draft specification
+         * being developed as a standard Web Platform API.
          *
-         * Calling `timersPromises.scheduler.wait(delay, options)` is roughly equivalent to calling `timersPromises.setTimeout(delay, undefined, options)` except that the `ref`
-         * option is not supported.
+         * Calling `timersPromises.scheduler.wait(delay, options)` is roughly equivalent
+         * to calling `timersPromises.setTimeout(delay, undefined, options)` except that
+         * the `ref` option is not supported.
          *
          * ```js
          * import { scheduler } from 'node:timers/promises';
          *
          * await scheduler.wait(1000); // Wait one second before continuing
          * ```
-         * @since v16.14.0
+         * @since v17.3.0, v16.14.0
          * @experimental
-         * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
+         * @param delay The number of milliseconds to wait before resolving the
+         * promise.
          */
-        wait: (delay?: number, options?: Pick<TimerOptions, "signal">) => Promise<void>;
+        wait(delay: number, options?: { signal?: AbortSignal }): Promise<void>;
         /**
-         * An experimental API defined by the [Scheduling APIs](https://nodejs.org/docs/latest-v20.x/api/async_hooks.html#promise-execution-tracking) draft specification
+         * An experimental API defined by the [Scheduling APIs](https://github.com/WICG/scheduling-apis) draft specification
          * being developed as a standard Web Platform API.
-         * Calling `timersPromises.scheduler.yield()` is equivalent to calling `timersPromises.setImmediate()` with no arguments.
-         * @since v16.14.0
+         *
+         * Calling `timersPromises.scheduler.yield()` is equivalent to calling
+         * `timersPromises.setImmediate()` with no arguments.
+         * @since v17.3.0, v16.14.0
          * @experimental
          */
-        yield: () => Promise<void>;
+        yield(): Promise<void>;
     }
     const scheduler: Scheduler;
 }

node v20.17/timers.d.ts

@@ -6,16 +6,12 @@
  * The timer functions within Node.js implement a similar API as the timers API
  * provided by Web Browsers but use a different internal implementation that is
  * built around the Node.js [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout).
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/timers.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.x/lib/timers.js)
  */
 declare module "timers" {
     import { Abortable } from "node:events";
-    import {
-        setImmediate as setImmediatePromise,
-        setInterval as setIntervalPromise,
-        setTimeout as setTimeoutPromise,
-    } from "node:timers/promises";
-    interface TimerOptions extends Abortable {
+    import * as promises from "node:timers/promises";
+    export interface TimerOptions extends Abortable {
         /**
          * Set to `false` to indicate that the scheduled `Timeout`
          * should not require the Node.js event loop to remain active.
@@ -23,38 +19,33 @@ declare module "timers" {
          */
         ref?: boolean | undefined;
     }
-    let setTimeout: typeof global.setTimeout;
-    let clearTimeout: typeof global.clearTimeout;
-    let setInterval: typeof global.setInterval;
-    let clearInterval: typeof global.clearInterval;
-    let setImmediate: typeof global.setImmediate;
-    let clearImmediate: typeof global.clearImmediate;
     global {
         namespace NodeJS {
-            // compatibility with older typings
-            interface Timer extends RefCounted {
-                hasRef(): boolean;
-                refresh(): this;
-                [Symbol.toPrimitive](): number;
-            }
             /**
              * This object is created internally and is returned from `setImmediate()`. It
              * can be passed to `clearImmediate()` in order to cancel the scheduled
              * actions.
              *
              * By default, when an immediate is scheduled, the Node.js event loop will continue
-             * running as long as the immediate is active. The `Immediate` object returned by `setImmediate()` exports both `immediate.ref()` and `immediate.unref()` functions that can be used to
-             * control this default behavior.
+             * running as long as the immediate is active. The `Immediate` object returned by
+             * `setImmediate()` exports both `immediate.ref()` and `immediate.unref()`
+             * functions that can be used to control this default behavior.
              */
-            class Immediate implements RefCounted {
+            interface Immediate extends RefCounted, Disposable {
                 /**
-                 * When called, requests that the Node.js event loop _not_ exit so long as the `Immediate` is active. Calling `immediate.ref()` multiple times will have no
+                 * If true, the `Immediate` object will keep the Node.js event loop active.
+                 * @since v11.0.0
+                 */
+                hasRef(): boolean;
+                /**
+                 * When called, requests that the Node.js event loop _not_ exit so long as the
+                 * `Immediate` is active. Calling `immediate.ref()` multiple times will have no
                  * effect.
                  *
                  * By default, all `Immediate` objects are "ref'ed", making it normally unnecessary
                  * to call `immediate.ref()` unless `immediate.unref()` had been called previously.
                  * @since v9.7.0
-                 * @return a reference to `immediate`
+                 * @returns a reference to `immediate`
                  */
                 ref(): this;
                 /**
@@ -63,53 +54,58 @@ declare module "timers" {
                  * running, the process may exit before the `Immediate` object's callback is
                  * invoked. Calling `immediate.unref()` multiple times will have no effect.
                  * @since v9.7.0
-                 * @return a reference to `immediate`
+                 * @returns a reference to `immediate`
                  */
                 unref(): this;
-                /**
-                 * If true, the `Immediate` object will keep the Node.js event loop active.
-                 * @since v11.0.0
-                 */
-                hasRef(): boolean;
-                _onImmediate: Function; // to distinguish it from the Timeout class
                 /**
                  * Cancels the immediate. This is similar to calling `clearImmediate()`.
-                 * @since v20.5.0
+                 * @since v20.5.0, v18.18.0
+                 * @experimental
                  */
                 [Symbol.dispose](): void;
+                _onImmediate(...args: any[]): void;
+            }
+            // Legacy interface used in Node.js v9 and prior
+            /** @deprecated Use `NodeJS.Timeout` instead. */
+            interface Timer extends RefCounted {
+                hasRef(): boolean;
+                refresh(): this;
+                [Symbol.toPrimitive](): number;
             }
             /**
-             * This object is created internally and is returned from `setTimeout()` and `setInterval()`. It can be passed to either `clearTimeout()` or `clearInterval()` in order to cancel the
-             * scheduled actions.
+             * This object is created internally and is returned from `setTimeout()` and
+             * `setInterval()`. It can be passed to either `clearTimeout()` or
+             * `clearInterval()` in order to cancel the scheduled actions.
              *
-             * By default, when a timer is scheduled using either `setTimeout()` or `setInterval()`, the Node.js event loop will continue running as long as the
+             * By default, when a timer is scheduled using either `setTimeout()` or
+             * `setInterval()`, the Node.js event loop will continue running as long as the
              * timer is active. Each of the `Timeout` objects returned by these functions
              * export both `timeout.ref()` and `timeout.unref()` functions that can be used to
              * control this default behavior.
              */
-            class Timeout implements Timer {
-                /**
-                 * When called, requests that the Node.js event loop _not_ exit so long as the`Timeout` is active. Calling `timeout.ref()` multiple times will have no effect.
-                 *
-                 * By default, all `Timeout` objects are "ref'ed", making it normally unnecessary
-                 * to call `timeout.ref()` unless `timeout.unref()` had been called previously.
-                 * @since v0.9.1
-                 * @return a reference to `timeout`
-                 */
-                ref(): this;
+            interface Timeout extends RefCounted, Disposable, Timer {
                 /**
-                 * When called, the active `Timeout` object will not require the Node.js event loop
-                 * to remain active. If there is no other activity keeping the event loop running,
-                 * the process may exit before the `Timeout` object's callback is invoked. Calling `timeout.unref()` multiple times will have no effect.
+                 * Cancels the timeout.
                  * @since v0.9.1
-                 * @return a reference to `timeout`
+                 * @legacy Use `clearTimeout()` instead.
+                 * @returns a reference to `timeout`
                  */
-                unref(): this;
+                close(): this;
                 /**
                  * If true, the `Timeout` object will keep the Node.js event loop active.
                  * @since v11.0.0
                  */
                 hasRef(): boolean;
+                /**
+                 * When called, requests that the Node.js event loop _not_ exit so long as the
+                 * `Timeout` is active. Calling `timeout.ref()` multiple times will have no effect.
+                 *
+                 * By default, all `Timeout` objects are "ref'ed", making it normally unnecessary
+                 * to call `timeout.ref()` unless `timeout.unref()` had been called previously.
+                 * @since v0.9.1
+                 * @returns a reference to `timeout`
+                 */
+                ref(): this;
                 /**
                  * Sets the timer's start time to the current time, and reschedules the timer to
                  * call its callback at the previously specified duration adjusted to the current
@@ -119,53 +115,69 @@ declare module "timers" {
                  * Using this on a timer that has already called its callback will reactivate the
                  * timer.
                  * @since v10.2.0
-                 * @return a reference to `timeout`
+                 * @returns a reference to `timeout`
                  */
                 refresh(): this;
+                /**
+                 * When called, the active `Timeout` object will not require the Node.js event loop
+                 * to remain active. If there is no other activity keeping the event loop running,
+                 * the process may exit before the `Timeout` object's callback is invoked. Calling
+                 * `timeout.unref()` multiple times will have no effect.
+                 * @since v0.9.1
+                 * @returns a reference to `timeout`
+                 */
+                unref(): this;
+                /**
+                 * Coerce a `Timeout` to a primitive. The primitive can be used to
+                 * clear the `Timeout`. The primitive can only be used in the
+                 * same thread where the timeout was created. Therefore, to use it
+                 * across `worker_threads` it must first be passed to the correct
+                 * thread. This allows enhanced compatibility with browser
+                 * `setTimeout()` and `setInterval()` implementations.
+                 * @since v14.9.0, v12.19.0
+                 */
                 [Symbol.toPrimitive](): number;
                 /**
                  * Cancels the timeout.
-                 * @since v20.5.0
+                 * @since v20.5.0, v18.18.0
+                 * @experimental
                  */
                 [Symbol.dispose](): void;
+                _onTimeout(...args: any[]): void;
             }
         }
         /**
-         * Schedules execution of a one-time `callback` after `delay` milliseconds.
-         *
-         * The `callback` will likely not be invoked in precisely `delay` milliseconds.
-         * Node.js makes no guarantees about the exact timing of when callbacks will fire,
-         * nor of their ordering. The callback will be called as close as possible to the
-         * time specified.
+         * Schedules the "immediate" execution of the `callback` after I/O events'
+         * callbacks.
          *
-         * When `delay` is larger than `2147483647` or less than `1`, the `delay` will be set to `1`. Non-integer delays are truncated to an integer.
+         * When multiple calls to `setImmediate()` are made, the `callback` functions are
+         * queued for execution in the order in which they are created. The entire callback
+         * queue is processed every event loop iteration. If an immediate timer is queued
+         * from inside an executing callback, that timer will not be triggered until the
+         * next event loop iteration.
          *
          * If `callback` is not a function, a `TypeError` will be thrown.
          *
-         * This method has a custom variant for promises that is available using `timersPromises.setTimeout()`.
-         * @since v0.0.1
-         * @param callback The function to call when the timer elapses.
-         * @param [delay=1] The number of milliseconds to wait before calling the `callback`.
+         * This method has a custom variant for promises that is available using
+         * `timersPromises.setImmediate()`.
+         * @since v0.9.1
+         * @param callback The function to call at the end of this turn of
+         * the Node.js [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout)
          * @param args Optional arguments to pass when the `callback` is called.
-         * @return for use with {@link clearTimeout}
+         * @returns for use with `clearImmediate()`
          */
-        function setTimeout<TArgs extends any[]>(
+        function setImmediate<TArgs extends any[]>(
             callback: (...args: TArgs) => void,
-            delay?: number,
             ...args: TArgs
-        ): NodeJS.Timeout;
-        // util.promisify no rest args compability
+        ): NodeJS.Immediate;
+        // Allow a single void-accepting argument to be optional in arguments lists.
+        // Allows usage such as `new Promise(resolve => setTimeout(resolve, ms))` (#54258)
         // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-        function setTimeout(callback: (args: void) => void, delay?: number): NodeJS.Timeout;
-        namespace setTimeout {
-            const __promisify__: typeof setTimeoutPromise;
+        function setImmediate(callback: (_: void) => void): NodeJS.Immediate;
+        namespace setImmediate {
+            import __promisify__ = promises.setImmediate;
+            export { __promisify__ };
         }
-        /**
-         * Cancels a `Timeout` object created by `setTimeout()`.
-         * @since v0.0.1
-         * @param timeout A `Timeout` object as returned by {@link setTimeout} or the `primitive` of the `Timeout` object as a string or a number.
-         */
-        function clearTimeout(timeoutId: NodeJS.Timeout | string | number | undefined): void;
         /**
          * Schedules repeated execution of `callback` every `delay` milliseconds.
          *
@@ -174,66 +186,100 @@ declare module "timers" {
          *
          * If `callback` is not a function, a `TypeError` will be thrown.
          *
-         * This method has a custom variant for promises that is available using `timersPromises.setInterval()`.
+         * This method has a custom variant for promises that is available using
+         * `timersPromises.setInterval()`.
          * @since v0.0.1
          * @param callback The function to call when the timer elapses.
-         * @param [delay=1] The number of milliseconds to wait before calling the `callback`.
+         * @param delay The number of milliseconds to wait before calling the
+         * `callback`. **Default:** `1`.
          * @param args Optional arguments to pass when the `callback` is called.
-         * @return for use with {@link clearInterval}
+         * @returns for use with `clearInterval()`
          */
         function setInterval<TArgs extends any[]>(
             callback: (...args: TArgs) => void,
             delay?: number,
             ...args: TArgs
         ): NodeJS.Timeout;
-        // util.promisify no rest args compability
+        // Allow a single void-accepting argument to be optional in arguments lists.
+        // Allows usage such as `new Promise(resolve => setTimeout(resolve, ms))` (#54258)
         // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-        function setInterval(callback: (args: void) => void, delay?: number): NodeJS.Timeout;
-        namespace setInterval {
-            const __promisify__: typeof setIntervalPromise;
-        }
-        /**
-         * Cancels a `Timeout` object created by `setInterval()`.
-         * @since v0.0.1
-         * @param timeout A `Timeout` object as returned by {@link setInterval} or the `primitive` of the `Timeout` object as a string or a number.
-         */
-        function clearInterval(intervalId: NodeJS.Timeout | string | number | undefined): void;
+        function setInterval(callback: (_: void) => void, delay?: number): NodeJS.Timeout;
         /**
-         * Schedules the "immediate" execution of the `callback` after I/O events'
-         * callbacks.
+         * Schedules execution of a one-time `callback` after `delay` milliseconds.
          *
-         * When multiple calls to `setImmediate()` are made, the `callback` functions are
-         * queued for execution in the order in which they are created. The entire callback
-         * queue is processed every event loop iteration. If an immediate timer is queued
-         * from inside an executing callback, that timer will not be triggered until the
-         * next event loop iteration.
+         * The `callback` will likely not be invoked in precisely `delay` milliseconds.
+         * Node.js makes no guarantees about the exact timing of when callbacks will fire,
+         * nor of their ordering. The callback will be called as close as possible to the
+         * time specified.
+         *
+         * When `delay` is larger than `2147483647` or less than `1` or `NaN`, the `delay`
+         * will be set to `1`. Non-integer delays are truncated to an integer.
          *
          * If `callback` is not a function, a `TypeError` will be thrown.
          *
-         * This method has a custom variant for promises that is available using `timersPromises.setImmediate()`.
-         * @since v0.9.1
-         * @param callback The function to call at the end of this turn of the Node.js `Event Loop`
+         * This method has a custom variant for promises that is available using
+         * `timersPromises.setTimeout()`.
+         * @since v0.0.1
+         * @param callback The function to call when the timer elapses.
+         * @param delay The number of milliseconds to wait before calling the
+         * `callback`. **Default:** `1`.
          * @param args Optional arguments to pass when the `callback` is called.
-         * @return for use with {@link clearImmediate}
+         * @returns for use with `clearTimeout()`
          */
-        function setImmediate<TArgs extends any[]>(
+        function setTimeout<TArgs extends any[]>(
             callback: (...args: TArgs) => void,
+            delay?: number,
             ...args: TArgs
-        ): NodeJS.Immediate;
-        // util.promisify no rest args compability
+        ): NodeJS.Timeout;
+        // Allow a single void-accepting argument to be optional in arguments lists.
+        // Allows usage such as `new Promise(resolve => setTimeout(resolve, ms))` (#54258)
         // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-        function setImmediate(callback: (args: void) => void): NodeJS.Immediate;
-        namespace setImmediate {
-            const __promisify__: typeof setImmediatePromise;
+        function setTimeout(callback: (_: void) => void, delay?: number): NodeJS.Timeout;
+        namespace setTimeout {
+            import __promisify__ = promises.setTimeout;
+            export { __promisify__ };
         }
         /**
          * Cancels an `Immediate` object created by `setImmediate()`.
          * @since v0.9.1
-         * @param immediate An `Immediate` object as returned by {@link setImmediate}.
+         * @param immediate An `Immediate` object as returned by `setImmediate()`.
+         */
+        function clearImmediate(immediate: NodeJS.Immediate | undefined): void;
+        /**
+         * Cancels a `Timeout` object created by `setInterval()`.
+         * @since v0.0.1
+         * @param timeout A `Timeout` object as returned by `setInterval()`
+         * or the primitive of the `Timeout` object as a string or a number.
+         */
+        function clearInterval(timeout: NodeJS.Timeout | string | number | undefined): void;
+        /**
+         * Cancels a `Timeout` object created by `setTimeout()`.
+         * @since v0.0.1
+         * @param timeout A `Timeout` object as returned by `setTimeout()`
+         * or the primitive of the `Timeout` object as a string or a number.
+         */
+        function clearTimeout(timeout: NodeJS.Timeout | string | number | undefined): void;
+        /**
+         * The `queueMicrotask()` method queues a microtask to invoke `callback`. If
+         * `callback` throws an exception, the `process` object `'uncaughtException'`
+         * event will be emitted.
+         *
+         * The microtask queue is managed by V8 and may be used in a similar manner to
+         * the `process.nextTick()` queue, which is managed by Node.js. The
+         * `process.nextTick()` queue is always processed before the microtask queue
+         * within each turn of the Node.js event loop.
+         * @since v11.0.0
+         * @param callback Function to be queued.
          */
-        function clearImmediate(immediateId: NodeJS.Immediate | undefined): void;
         function queueMicrotask(callback: () => void): void;
     }
+    import clearImmediate = globalThis.clearImmediate;
+    import clearInterval = globalThis.clearInterval;
+    import clearTimeout = globalThis.clearTimeout;
+    import setImmediate = globalThis.setImmediate;
+    import setInterval = globalThis.setInterval;
+    import setTimeout = globalThis.setTimeout;
+    export { clearImmediate, clearInterval, clearTimeout, promises, setImmediate, setInterval, setTimeout };
 }
 declare module "node:timers" {
     export * from "timers";