@types/node 18.16.5 → 20.1.0

node v18.16/timers/promises.d.ts → 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,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 v18.16/timers.d.ts → 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.1.0/lib/timers.js)
  */
 declare module 'timers' {
     import { Abortable } from 'node:events';

node v18.16/ts4.8/tls.d.ts → 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.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 v18.16/ts4.8/trace_events.d.ts → 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.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'] });