@types/node 18.16.3 → 20.1.0

node/ts4.8/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,7 +64,6 @@ declare module 'timers/promises' {
      * @since v15.9.0
      */
     function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
-
     interface Scheduler {
         /**
          * ```js
@@ -85,7 +86,6 @@ declare module 'timers/promises' {
          */
         yield: () => Promise<void>;
     }
-
     const scheduler: Scheduler;
 }
 declare module 'node:timers/promises' {

node/ts4.8/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.1.0/lib/timers.js)
  */
 declare module 'timers' {
     import { Abortable } from 'node:events';
@@ -62,6 +62,13 @@ 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](https://nodejs.org/api/errors.html#class-typeerror) will be thrown.
+         * @since v0.0.1
+         */
         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

node/ts4.8/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.1.0/lib/tls.js)
  */
 declare module 'tls' {
     import { X509Certificate } from 'node:crypto';
@@ -212,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
      */
@@ -259,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"
          * }
          * ```
          *
@@ -637,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;
         /**
@@ -912,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'),
@@ -929,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) => {
@@ -964,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.
@@ -1041,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;

node/ts4.8/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.1.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'] });

node/ts4.8/tty.d.ts

@@ -1,10 +1,9 @@
 /**
- * The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes.
- * In most cases, it will not be necessary or possible to use this module directly.
- * However, it can be accessed using:
+ * The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream`classes. In most cases, it will not be necessary or possible to use this module
+ * directly. However, it can be accessed using:
  *
  * ```js
- * const tty = require('tty');
+ * const tty = require('node:tty');
  * ```
  *
  * When Node.js detects that it is being run with a text terminal ("TTY")
@@ -22,7 +21,7 @@
  *
  * In most cases, there should be little to no reason for an application to
  * manually create instances of the `tty.ReadStream` and `tty.WriteStream`classes.
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/tty.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.1.0/lib/tty.js)
  */
 declare module 'tty' {
     import * as net from 'node:net';

node/ts4.8/url.d.ts

@@ -1,11 +1,11 @@
 /**
- * The `url` module provides utilities for URL resolution and parsing. It can be
- * accessed using:
+ * The `node:url` module provides utilities for URL resolution and parsing. It can
+ * be accessed using:
  *
  * ```js
- * import url from 'url';
+ * import url from 'node:url';
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/url.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.1.0/lib/url.js)
  */
 declare module 'url' {
     import { Blob as NodeBlob } from 'node:buffer';
@@ -54,17 +54,11 @@ declare module 'url' {
      *
      * A `URIError` is thrown if the `auth` property is present but cannot be decoded.
      *
-     * Use of the legacy `url.parse()` method is discouraged. Users should
-     * use the WHATWG `URL` API. Because the `url.parse()` method uses a
-     * lenient, non-standard algorithm for parsing URL strings, security
-     * issues can be introduced. Specifically, issues with [host name spoofing](https://hackerone.com/reports/678487) and
-     * incorrect handling of usernames and passwords have been identified.
-     *
-     * Deprecation of this API has been shelved for now primarily due to the the
-     * inability of the [WHATWG API to parse relative URLs](https://github.com/nodejs/node/issues/12682#issuecomment-1154492373).
-     * [Discussions are ongoing](https://github.com/whatwg/url/issues/531) for the  best way to resolve this.
-     *
+     * `url.parse()` uses a lenient, non-standard algorithm for parsing URL
+     * strings. It is prone to security issues such as [host name spoofing](https://hackerone.com/reports/678487) and incorrect handling of usernames and passwords. Do not use with untrusted
+     * input. CVEs are not issued for `url.parse()` vulnerabilities. Use the `WHATWG URL` API instead.
      * @since v0.1.25
+     * @deprecated Use the WHATWG URL API instead.
      * @param urlString The URL string to parse.
      * @param [parseQueryString=false] If `true`, the `query` property will always be set to an object returned by the {@link querystring} module's `parse()` method. If `false`, the `query` property
      * on the returned URL object will be an unparsed, undecoded string.
@@ -79,15 +73,15 @@ declare module 'url' {
      * The `url.format()` method returns a formatted URL string derived from`urlObject`.
      *
      * ```js
-     * const url = require('url');
+     * const url = require('node:url');
      * url.format({
      *   protocol: 'https',
      *   hostname: 'example.com',
      *   pathname: '/some/path',
      *   query: {
      *     page: 1,
-     *     format: 'json'
-     *   }
+     *     format: 'json',
+     *   },
      * });
      *
      * // => 'https://example.com/some/path?page=1&format=json'
@@ -208,7 +202,7 @@ declare module 'url' {
      * manner similar to that of a web browser resolving an anchor tag.
      *
      * ```js
-     * const url = require('url');
+     * const url = require('node:url');
      * url.resolve('/one/two/three', 'four');         // '/one/two/four'
      * url.resolve('http://example.com/', '/one');    // 'http://example.com/one'
      * url.resolve('http://example.com/one', '/two'); // 'http://example.com/two'
@@ -243,10 +237,8 @@ declare module 'url' {
      *
      * It performs the inverse operation to {@link domainToUnicode}.
      *
-     * This feature is only available if the `node` executable was compiled with `ICU` enabled. If not, the domain names are passed through unchanged.
-     *
      * ```js
-     * import url from 'url';
+     * import url from 'node:url';
      *
      * console.log(url.domainToASCII('español.com'));
      * // Prints xn--espaol-zwa.com
@@ -264,10 +256,8 @@ declare module 'url' {
      *
      * It performs the inverse operation to {@link domainToASCII}.
      *
-     * This feature is only available if the `node` executable was compiled with `ICU` enabled. If not, the domain names are passed through unchanged.
-     *
      * ```js
-     * import url from 'url';
+     * import url from 'node:url';
      *
      * console.log(url.domainToUnicode('xn--espaol-zwa.com'));
      * // Prints español.com
@@ -284,7 +274,7 @@ declare module 'url' {
      * well as ensuring a cross-platform valid absolute path string.
      *
      * ```js
-     * import { fileURLToPath } from 'url';
+     * import { fileURLToPath } from 'node:url';
      *
      * const __filename = fileURLToPath(import.meta.url);
      *
@@ -310,7 +300,7 @@ declare module 'url' {
      * control characters are correctly encoded when converting into a File URL.
      *
      * ```js
-     * import { pathToFileURL } from 'url';
+     * import { pathToFileURL } from 'node:url';
      *
      * new URL('/foo#1', 'file:');           // Incorrect: file:///foo#1
      * pathToFileURL('/foo#1');              // Correct:   file:///foo%231 (POSIX)
@@ -328,7 +318,7 @@ declare module 'url' {
      * expected by the `http.request()` and `https.request()` APIs.
      *
      * ```js
-     * import { urlToHttpOptions } from 'url';
+     * import { urlToHttpOptions } from 'node:url';
      * const myURL = new URL('https://a:b@測試?abc#foo');
      *
      * console.log(urlToHttpOptions(myURL));
@@ -376,7 +366,7 @@ declare module 'url' {
          * const {
          *   Blob,
          *   resolveObjectURL,
-         * } = require('buffer');
+         * } = require('node:buffer');
          *
          * const blob = new Blob(['hello']);
          * const id = URL.createObjectURL(blob);
@@ -398,7 +388,7 @@ declare module 'url' {
         static createObjectURL(blob: NodeBlob): string;
         /**
          * Removes the stored `Blob` identified by the given ID. Attempting to revoke a
-         * ID that isn’t registered will silently fail.
+         * ID that isn't registered will silently fail.
          * @since v16.7.0
          * @experimental
          * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
@@ -449,7 +439,7 @@ declare module 'url' {
          * // Prints example.org
          *
          * // Setting the hostname does not change the port
-         * myURL.hostname = 'example.com:82';
+         * myURL.hostname = 'example.com';
          * console.log(myURL.href);
          * // Prints https://example.com:81/foo
          *
@@ -512,7 +502,7 @@ declare module 'url' {
          *
          * myURL.password = '123';
          * console.log(myURL.href);
-         * // Prints https://abc:123@example.com
+         * // Prints https://abc:123@example.com/
          * ```
          *
          * Invalid URL characters included in the value assigned to the `password` property
@@ -656,14 +646,14 @@ declare module 'url' {
          * character, while `URLSearchParams` will always encode it:
          *
          * ```js
-         * const myUrl = new URL('https://example.org/abc?foo=~bar');
+         * const myURL = new URL('https://example.org/abc?foo=~bar');
          *
-         * console.log(myUrl.search);  // prints ?foo=~bar
+         * console.log(myURL.search);  // prints ?foo=~bar
          *
          * // Modify the URL via searchParams...
-         * myUrl.searchParams.sort();
+         * myURL.searchParams.sort();
          *
-         * console.log(myUrl.search);  // prints ?foo=%7Ebar
+         * console.log(myURL.search);  // prints ?foo=%7Ebar
          * ```
          */
         readonly searchParams: URLSearchParams;
@@ -835,7 +825,7 @@ declare module 'url' {
         set(name: string, value: string): void;
         /**
          * The total number of parameter entries.
-         * @since v18.16.0
+         * @since v19.8.0
          */
         readonly size: number;
         /**