@types/node 18.11.5 → 20.2.5

node/timers/promises.d.ts

@@ -1,6 +1,6 @@
 /**
  * The `timers/promises` API provides an alternative set of timer functions
- * that return `Promise` objects. The API is accessible via`require('timers/promises')`.
+ * that return `Promise` objects. The API is accessible via`require('node:timers/promises')`.
  *
  * ```js
  * import {
@@ -44,6 +44,8 @@ declare module 'timers/promises' {
     function setImmediate<T = void>(value?: T, options?: TimerOptions): Promise<T>;
     /**
      * Returns an async iterator that generates values in an interval of `delay` ms.
+     * If `ref` is `true`, you need to call `next()` of async iterator explicitly
+     * or implicitly to keep the event loop alive.
      *
      * ```js
      * import {
@@ -62,6 +64,29 @@ declare module 'timers/promises' {
      * @since v15.9.0
      */
     function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
+    interface Scheduler {
+        /**
+         * ```js
+         * import { scheduler } from 'node:timers/promises';
+         *
+         * await scheduler.wait(1000); // Wait one second before continuing
+         * ```
+         * An experimental API defined by the 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.
+         * @since v16.14.0
+         * @experimental
+         * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
+         */
+        wait: (delay?: number, options?: TimerOptions) => Promise<void>;
+        /**
+         * An experimental API defined by the 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
+         * @experimental
+         */
+        yield: () => Promise<void>;
+    }
+    const scheduler: Scheduler;
 }
 declare module 'node:timers/promises' {
     export * from 'timers/promises';

node/timers.d.ts

@@ -1,12 +1,12 @@
 /**
  * The `timer` module exposes a global API for scheduling functions to
  * be called at some future period of time. Because the timer functions are
- * globals, there is no need to call `require('timers')` to use the API.
+ * globals, there is no need to call `require('node:timers')` to use the API.
  *
  * 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/v18.0.0/lib/timers.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/timers.js)
  */
 declare module 'timers' {
     import { Abortable } from 'node:events';
@@ -33,7 +33,35 @@ declare module 'timers' {
                 refresh(): this;
                 [Symbol.toPrimitive](): number;
             }
-            interface Immediate extends RefCounted {
+            /**
+             * 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.
+             */
+            class Immediate implements RefCounted {
+                /**
+                 * 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`
+                 */
+                ref(): this;
+                /**
+                 * When called, the active `Immediate` 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 `Immediate` object's callback is
+                 * invoked. Calling `immediate.unref()` multiple times will have no effect.
+                 * @since v9.7.0
+                 * @return a reference to `immediate`
+                 */
+                unref(): this;
                 /**
                  * If true, the `Immediate` object will keep the Node.js event loop active.
                  * @since v11.0.0
@@ -41,7 +69,33 @@ declare module 'timers' {
                 hasRef(): boolean;
                 _onImmediate: Function; // to distinguish it from the Timeout class
             }
-            interface Timeout extends Timer {
+            /**
+             * 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
+             * 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;
+                /**
+                 * 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
+                 * @return a reference to `timeout`
+                 */
+                unref(): this;
                 /**
                  * If true, the `Timeout` object will keep the Node.js event loop active.
                  * @since v11.0.0
@@ -62,6 +116,25 @@ declare module 'timers' {
                 [Symbol.toPrimitive](): number;
             }
         }
+        /**
+         * 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.
+         *
+         * 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.
+         *
+         * 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`.
+         * @param args Optional arguments to pass when the `callback` is called.
+         * @return for use with {@link clearTimeout}
+         */
         function setTimeout<TArgs extends any[]>(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timeout;
         // util.promisify no rest args compability
         // tslint:disable-next-line void-return
@@ -69,7 +142,27 @@ declare module 'timers' {
         namespace setTimeout {
             const __promisify__: typeof setTimeoutPromise;
         }
+        /**
+         * 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.
+         *
+         * 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.
+         *
+         * 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()`.
+         * @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 args Optional arguments to pass when the `callback` is called.
+         * @return for use with {@link clearInterval}
+         */
         function setInterval<TArgs extends any[]>(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timer;
         // util.promisify no rest args compability
         // tslint:disable-next-line void-return
@@ -77,7 +170,30 @@ declare module 'timers' {
         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;
+        /**
+         * Schedules the "immediate" execution of the `callback` after I/O events'
+         * callbacks.
+         *
+         * 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.setImmediate()`.
+         * @since v0.9.1
+         * @param callback The function to call at the end of this turn of the Node.js `Event Loop`
+         * @param args Optional arguments to pass when the `callback` is called.
+         * @return for use with {@link clearImmediate}
+         */
         function setImmediate<TArgs extends any[]>(callback: (...args: TArgs) => void, ...args: TArgs): NodeJS.Immediate;
         // util.promisify no rest args compability
         // tslint:disable-next-line void-return
@@ -85,6 +201,11 @@ declare module 'timers' {
         namespace setImmediate {
             const __promisify__: typeof setImmediatePromise;
         }
+        /**
+         * Cancels an `Immediate` object created by `setImmediate()`.
+         * @since v0.9.1
+         * @param immediate An `Immediate` object as returned by {@link setImmediate}.
+         */
         function clearImmediate(immediateId: NodeJS.Immediate | undefined): void;
         function queueMicrotask(callback: () => void): void;
     }

node/tls.d.ts

@@ -1,12 +1,12 @@
 /**
- * The `tls` module provides an implementation of the Transport Layer Security
+ * The `node:tls` module provides an implementation of the Transport Layer Security
  * (TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL.
  * The module can be accessed using:
  *
  * ```js
- * const tls = require('tls');
+ * const tls = require('node:tls');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/tls.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/tls.js)
  */
 declare module 'tls' {
     import { X509Certificate } from 'node:crypto';
@@ -41,21 +41,100 @@ declare module 'tls' {
         CN: string;
     }
     interface PeerCertificate {
+        /**
+         * `true` if a Certificate Authority (CA), `false` otherwise.
+         * @since v18.13.0
+         */
+        ca: boolean;
+        /**
+         * The DER encoded X.509 certificate data.
+         */
+        raw: Buffer;
+        /**
+         * The certificate subject.
+         */
         subject: Certificate;
+        /**
+         * The certificate issuer, described in the same terms as the `subject`.
+         */
         issuer: Certificate;
-        subjectaltname: string;
-        infoAccess: NodeJS.Dict<string[]>;
-        modulus: string;
-        exponent: string;
+        /**
+         * The date-time the certificate is valid from.
+         */
         valid_from: string;
+        /**
+         * The date-time the certificate is valid to.
+         */
         valid_to: string;
+        /**
+         * The certificate serial number, as a hex string.
+         */
+        serialNumber: string;
+        /**
+         * The SHA-1 digest of the DER encoded certificate.
+         * It is returned as a `:` separated hexadecimal string.
+         */
         fingerprint: string;
+        /**
+         * The SHA-256 digest of the DER encoded certificate.
+         * It is returned as a `:` separated hexadecimal string.
+         */
         fingerprint256: string;
-        ext_key_usage: string[];
-        serialNumber: string;
-        raw: Buffer;
+        /**
+         * The SHA-512 digest of the DER encoded certificate.
+         * It is returned as a `:` separated hexadecimal string.
+         */
+        fingerprint512: string;
+        /**
+         * The extended key usage, a set of OIDs.
+         */
+        ext_key_usage?: string[];
+        /**
+         * A string containing concatenated names for the subject,
+         * an alternative to the `subject` names.
+         */
+        subjectaltname?: string;
+        /**
+         * An array describing the AuthorityInfoAccess, used with OCSP.
+         */
+        infoAccess?: NodeJS.Dict<string[]>;
+        /**
+         * For RSA keys: The RSA bit size.
+         *
+         * For EC keys: The key size in bits.
+         */
+        bits?: number;
+        /**
+         * The RSA exponent, as a string in hexadecimal number notation.
+         */
+        exponent?: string;
+        /**
+         * The RSA modulus, as a hexadecimal string.
+         */
+        modulus?: string;
+        /**
+         * The public key.
+         */
+        pubkey?: Buffer;
+        /**
+         * The ASN.1 name of the OID of the elliptic curve.
+         * Well-known curves are identified by an OID.
+         * While it is unusual, it is possible that the curve
+         * is identified by its mathematical properties,
+         * in which case it will not have an OID.
+         */
+        asn1Curve?: string;
+        /**
+         * The NIST name for the elliptic curve,if it has one
+         * (not all well-known curves have been assigned names by NIST).
+         */
+        nistCurve?: string;
     }
     interface DetailedPeerCertificate extends PeerCertificate {
+        /**
+         * The issuer certificate object.
+         * For self-signed certificates, this may be a circular reference.
+         */
         issuerCertificate: DetailedPeerCertificate;
     }
     interface CipherNameAndProtocol {
@@ -133,7 +212,7 @@ declare module 'tls' {
      *
      * Instances of `tls.TLSSocket` implement the duplex `Stream` interface.
      *
-     * Methods that return TLS connection metadata (e.g.{@link TLSSocket.getPeerCertificate} will only return data while the
+     * Methods that return TLS connection metadata (e.g.{@link TLSSocket.getPeerCertificate}) will only return data while the
      * connection is open.
      * @since v0.11.4
      */
@@ -180,13 +259,13 @@ declare module 'tls' {
         /**
          * Returns an object containing information on the negotiated cipher suite.
          *
-         * For example:
+         * For example, a TLSv1.2 protocol with AES256-SHA cipher:
          *
          * ```json
          * {
-         *     "name": "AES128-SHA256",
-         *     "standardName": "TLS_RSA_WITH_AES_128_CBC_SHA256",
-         *     "version": "TLSv1.2"
+         *     "name": "AES256-SHA",
+         *     "standardName": "TLS_RSA_WITH_AES_256_CBC_SHA",
+         *     "version": "SSLv3"
          * }
          * ```
          *
@@ -558,7 +637,8 @@ declare module 'tls' {
          * used.
          * @since v0.5.3
          * @param hostname A SNI host name or wildcard (e.g. `'*'`)
-         * @param context An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc).
+         * @param context An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc), or a TLS context object created
+         * with {@link createSecureContext} itself.
          */
         addContext(hostname: string, context: SecureContextOptions): void;
         /**
@@ -689,12 +769,9 @@ declare module 'tls' {
          */
         crl?: string | Buffer | Array<string | Buffer> | undefined;
         /**
-         * Diffie Hellman parameters, required for Perfect Forward Secrecy. Use
-         * openssl dhparam to create the parameters. The key length must be
-         * greater than or equal to 1024 bits or else an error will be thrown.
-         * Although 1024 bits is permissible, use 2048 bits or larger for
-         * stronger security. If omitted or invalid, the parameters are
-         * silently discarded and DHE ciphers will not be available.
+         * `'auto'` or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy.
+         * If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
+         * ECDHE-based perfect forward secrecy will still be available.
          */
         dhparam?: string | Buffer | undefined;
         /**
@@ -836,14 +913,14 @@ declare module 'tls' {
      * Creates a new {@link Server}. The `secureConnectionListener`, if provided, is
      * automatically set as a listener for the `'secureConnection'` event.
      *
-     * The `ticketKeys` options is automatically shared between `cluster` module
+     * The `ticketKeys` options is automatically shared between `node:cluster` module
      * workers.
      *
      * The following illustrates a simple echo server:
      *
      * ```js
-     * const tls = require('tls');
-     * const fs = require('fs');
+     * const tls = require('node:tls');
+     * const fs = require('node:fs');
      *
      * const options = {
      *   key: fs.readFileSync('server-key.pem'),
@@ -853,7 +930,7 @@ declare module 'tls' {
      *   requestCert: true,
      *
      *   // This is necessary only if the client uses a self-signed certificate.
-     *   ca: [ fs.readFileSync('client-cert.pem') ]
+     *   ca: [ fs.readFileSync('client-cert.pem') ],
      * };
      *
      * const server = tls.createServer(options, (socket) => {
@@ -888,8 +965,8 @@ declare module 'tls' {
      *
      * ```js
      * // Assumes an echo server that is listening on port 8000.
-     * const tls = require('tls');
-     * const fs = require('fs');
+     * const tls = require('node:tls');
+     * const fs = require('node:fs');
      *
      * const options = {
      *   // Necessary only if the server requires client certificate authentication.
@@ -965,12 +1042,19 @@ declare module 'tls' {
      * APIs that create secure contexts have no default value.
      *
      * The `tls.createSecureContext()` method creates a `SecureContext` object. It is
-     * usable as an argument to several `tls` APIs, such as {@link createServer} and `server.addContext()`, but has no public methods.
+     * usable as an argument to several `tls` APIs, such as `server.addContext()`,
+     * but has no public methods. The {@link Server} constructor and the {@link createServer} method do not support the `secureContext` option.
      *
      * A key is _required_ for ciphers that use certificates. Either `key` or`pfx` can be used to provide it.
      *
      * If the `ca` option is not given, then Node.js will default to using [Mozilla's publicly trusted list of
      * CAs](https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt).
+     *
+     * Custom DHE parameters are discouraged in favor of the new `dhparam: 'auto'`option. When set to `'auto'`, well-known DHE parameters of sufficient strength
+     * will be selected automatically. Otherwise, if necessary, `openssl dhparam` can
+     * be used to create custom parameters. The key length must be greater than or
+     * equal to 1024 bits or else an error will be thrown. Although 1024 bits is
+     * permissible, use 2048 bits or larger for stronger security.
      * @since v0.11.13
      */
     function createSecureContext(options?: SecureContextOptions): SecureContext;
@@ -1016,6 +1100,13 @@ declare module 'tls' {
      * are provided, the lowest minimum is used.
      */
     let DEFAULT_MIN_VERSION: SecureVersion;
+    /**
+     * The default value of the ciphers option of tls.createSecureContext().
+     * It can be assigned any of the supported OpenSSL ciphers.
+     * Defaults to the content of crypto.constants.defaultCoreCipherList, unless
+     * changed using CLI options using --tls-default-ciphers.
+     */
+    let DEFAULT_CIPHERS: string;
     /**
      * An immutable array of strings representing the root certificates (in PEM
      * format) used for verifying peer certificates. This is the default value

node/trace_events.d.ts

@@ -1,9 +1,9 @@
 /**
- * The `trace_events` module provides a mechanism to centralize tracing information
- * generated by V8, Node.js core, and userspace code.
+ * The `node:trace_events` module provides a mechanism to centralize tracing
+ * information generated by V8, Node.js core, and userspace code.
  *
  * Tracing can be enabled with the `--trace-event-categories` command-line flag
- * or by using the `trace_events` module. The `--trace-event-categories` flag
+ * or by using the `node:trace_events` module. The `--trace-event-categories` flag
  * accepts a list of comma-separated category names.
  *
  * The available categories are:
@@ -13,9 +13,19 @@
  * The `async_hooks` events have a unique `asyncId` and a special `triggerId` `triggerAsyncId` property.
  * * `node.bootstrap`: Enables capture of Node.js bootstrap milestones.
  * * `node.console`: Enables capture of `console.time()` and `console.count()`output.
+ * * `node.threadpoolwork.sync`: Enables capture of trace data for threadpool
+ * synchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
+ * * `node.threadpoolwork.async`: Enables capture of trace data for threadpool
+ * asynchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
  * * `node.dns.native`: Enables capture of trace data for DNS queries.
+ * * `node.net.native`: Enables capture of trace data for network.
  * * `node.environment`: Enables capture of Node.js Environment milestones.
  * * `node.fs.sync`: Enables capture of trace data for file system sync methods.
+ * * `node.fs_dir.sync`: Enables capture of trace data for file system sync
+ * directory methods.
+ * * `node.fs.async`: Enables capture of trace data for file system async methods.
+ * * `node.fs_dir.async`: Enables capture of trace data for file system async
+ * directory methods.
  * * `node.perf`: Enables capture of `Performance API` measurements.
  *    * `node.perf.usertiming`: Enables capture of only Performance API User Timing
  *    measures and marks.
@@ -23,8 +33,9 @@
  *    measurements.
  * * `node.promises.rejections`: Enables capture of trace data tracking the number
  * of unhandled Promise rejections and handled-after-rejections.
- * * `node.vm.script`: Enables capture of trace data for the `vm` module's`runInNewContext()`, `runInContext()`, and `runInThisContext()` methods.
+ * * `node.vm.script`: Enables capture of trace data for the `node:vm` module's`runInNewContext()`, `runInContext()`, and `runInThisContext()` methods.
  * * `v8`: The `V8` events are GC, compiling, and execution related.
+ * * `node.http`: Enables capture of trace data for http request / response.
  *
  * By default the `node`, `node.async_hooks`, and `v8` categories are enabled.
  *
@@ -43,10 +54,10 @@
  * node --trace-event-categories v8,node,node.async_hooks
  * ```
  *
- * Alternatively, trace events may be enabled using the `trace_events` module:
+ * Alternatively, trace events may be enabled using the `node:trace_events` module:
  *
  * ```js
- * const trace_events = require('trace_events');
+ * const trace_events = require('node:trace_events');
  * const tracing = trace_events.createTracing({ categories: ['node.perf'] });
  * tracing.enable();  // Enable trace event capture for the 'node.perf' category
  *
@@ -83,7 +94,7 @@
  *
  * The features from this module are not available in `Worker` threads.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/trace_events.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/trace_events.js)
  */
 declare module 'trace_events' {
     /**
@@ -132,7 +143,7 @@ declare module 'trace_events' {
      * Creates and returns a `Tracing` object for the given set of `categories`.
      *
      * ```js
-     * const trace_events = require('trace_events');
+     * const trace_events = require('node:trace_events');
      * const categories = ['node.perf', 'node.async_hooks'];
      * const tracing = trace_events.createTracing({ categories });
      * tracing.enable();
@@ -152,7 +163,7 @@ declare module 'trace_events' {
      * Given the file `test.js` below, the command`node --trace-event-categories node.perf test.js` will print`'node.async_hooks,node.perf'` to the console.
      *
      * ```js
-     * const trace_events = require('trace_events');
+     * const trace_events = require('node:trace_events');
      * const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] });
      * const t2 = trace_events.createTracing({ categories: ['node.perf'] });
      * const t3 = trace_events.createTracing({ categories: ['v8'] });