@types/node 18.16.3 → 20.0.0

node/path.d.ts

@@ -7,13 +7,13 @@ declare module 'path/win32' {
     export = path;
 }
 /**
- * The `path` module provides utilities for working with file and directory paths.
- * It can be accessed using:
+ * The `node:path` module provides utilities for working with file and directory
+ * paths. It can be accessed using:
  *
  * ```js
- * const path = require('path');
+ * const path = require('node:path');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/path.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.0.0/lib/path.js)
  */
 declare module 'path' {
     namespace path {

node/perf_hooks.d.ts

@@ -7,9 +7,10 @@
  * * [High Resolution Time](https://www.w3.org/TR/hr-time-2)
  * * [Performance Timeline](https://w3c.github.io/performance-timeline/)
  * * [User Timing](https://www.w3.org/TR/user-timing/)
+ * * [Resource Timing](https://www.w3.org/TR/resource-timing-2/)
  *
  * ```js
- * const { PerformanceObserver, performance } = require('perf_hooks');
+ * const { PerformanceObserver, performance } = require('node:perf_hooks');
  *
  * const obs = new PerformanceObserver((items) => {
  *   console.log(items.getEntries()[0].duration);
@@ -26,7 +27,7 @@
  *   performance.measure('A to B', 'A', 'B');
  * });
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/perf_hooks.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.0.0/lib/perf_hooks.js)
  */
 declare module 'perf_hooks' {
     import { AsyncResource } from 'node:async_hooks';
@@ -46,6 +47,7 @@ declare module 'perf_hooks' {
         readonly flags?: number | undefined;
     }
     /**
+     * The constructor of this class is not exposed to users directly.
      * @since v8.5.0
      */
     class PerformanceEntry {
@@ -87,10 +89,20 @@ declare module 'perf_hooks' {
         readonly detail?: NodeGCPerformanceDetail | unknown | undefined; // TODO: Narrow this based on entry type.
         toJSON(): any;
     }
+    /**
+     * Exposes marks created via the `Performance.mark()` method.
+     * @since v18.2.0, v16.17.0
+     */
     class PerformanceMark extends PerformanceEntry {
         readonly duration: 0;
         readonly entryType: 'mark';
     }
+    /**
+     * Exposes measures created via the `Performance.measure()` method.
+     *
+     * The constructor of this class is not exposed to users directly.
+     * @since v18.2.0, v16.17.0
+     */
     class PerformanceMeasure extends PerformanceEntry {
         readonly entryType: 'measure';
     }
@@ -288,8 +300,8 @@ declare module 'perf_hooks' {
          * ```js
          * const {
          *   performance,
-         *   PerformanceObserver
-         * } = require('perf_hooks');
+         *   PerformanceObserver,
+         * } = require('node:perf_hooks');
          *
          * const obs = new PerformanceObserver((perfObserverList, observer) => {
          *   console.log(perfObserverList.getEntries());
@@ -330,8 +342,8 @@ declare module 'perf_hooks' {
          * ```js
          * const {
          *   performance,
-         *   PerformanceObserver
-         * } = require('perf_hooks');
+         *   PerformanceObserver,
+         * } = require('node:perf_hooks');
          *
          * const obs = new PerformanceObserver((perfObserverList, observer) => {
          *   console.log(perfObserverList.getEntriesByName('meow'));
@@ -379,8 +391,8 @@ declare module 'perf_hooks' {
          * ```js
          * const {
          *   performance,
-         *   PerformanceObserver
-         * } = require('perf_hooks');
+         *   PerformanceObserver,
+         * } = require('node:perf_hooks');
          *
          * const obs = new PerformanceObserver((perfObserverList, observer) => {
          *   console.log(perfObserverList.getEntriesByType('mark'));
@@ -414,6 +426,9 @@ declare module 'perf_hooks' {
         getEntriesByType(type: EntryType): PerformanceEntry[];
     }
     type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void;
+    /**
+     * @since v8.5.0
+     */
     class PerformanceObserver extends AsyncResource {
         constructor(callback: PerformanceObserverCallback);
         /**
@@ -427,8 +442,8 @@ declare module 'perf_hooks' {
          * ```js
          * const {
          *   performance,
-         *   PerformanceObserver
-         * } = require('perf_hooks');
+         *   PerformanceObserver,
+         * } = require('node:perf_hooks');
          *
          * const obs = new PerformanceObserver((list, observer) => {
          *   // Called once asynchronously. `list` contains three items.
@@ -547,11 +562,10 @@ declare module 'perf_hooks' {
          */
         recordDelta(): void;
         /**
-         * Adds the values from other to this histogram.
+         * Adds the values from `other` to this histogram.
          * @since v17.4.0, v16.14.0
-         * @param other Recordable Histogram to combine with
          */
-         add(other: RecordableHistogram): void;
+        add(other: RecordableHistogram): void;
     }
     /**
      * _This property is an extension by Node.js. It is not available in Web browsers._
@@ -566,7 +580,7 @@ declare module 'perf_hooks' {
      * detect.
      *
      * ```js
-     * const { monitorEventLoopDelay } = require('perf_hooks');
+     * const { monitorEventLoopDelay } = require('node:perf_hooks');
      * const h = monitorEventLoopDelay({ resolution: 20 });
      * h.enable();
      * // Do something.
@@ -604,7 +618,6 @@ declare module 'perf_hooks' {
      * @since v15.9.0, v14.18.0
      */
     function createHistogram(options?: CreateHistogramOptions): RecordableHistogram;
-
     import { performance as _performance } from 'perf_hooks';
     global {
         /**

node/process.d.ts

@@ -250,7 +250,7 @@ declare module 'process' {
                  * For example, to copy `process.stdin` to `process.stdout`:
                  *
                  * ```js
-                 * import { stdin, stdout } from 'process';
+                 * import { stdin, stdout } from 'node:process';
                  *
                  * stdin.pipe(stdout);
                  * ```
@@ -297,7 +297,7 @@ declare module 'process' {
                  * For example, assuming the following script for `process-args.js`:
                  *
                  * ```js
-                 * import { argv } from 'process';
+                 * import { argv } from 'node:process';
                  *
                  * // print process.argv
                  * argv.forEach((val, index) => {
@@ -389,7 +389,7 @@ declare module 'process' {
                  * the specified `directory` does not exist).
                  *
                  * ```js
-                 * import { chdir, cwd } from 'process';
+                 * import { chdir, cwd } from 'node:process';
                  *
                  * console.log(`Starting directory: ${cwd()}`);
                  * try {
@@ -409,7 +409,7 @@ declare module 'process' {
                  * process.
                  *
                  * ```js
-                 * import { cwd } from 'process';
+                 * import { cwd } from 'node:process';
                  *
                  * console.log(`Current directory: ${cwd()}`);
                  * ```
@@ -420,7 +420,7 @@ declare module 'process' {
                  * The port used by the Node.js debugger when enabled.
                  *
                  * ```js
-                 * import process from 'process';
+                 * import process from 'node:process';
                  *
                  * process.debugPort = 5858;
                  * ```
@@ -432,12 +432,12 @@ declare module 'process' {
                  * specific process warnings. These can be listened for by adding a handler to the `'warning'` event.
                  *
                  * ```js
-                 * import { emitWarning } from 'process';
+                 * import { emitWarning } from 'node:process';
                  *
                  * // Emit a warning with a code and additional detail.
                  * emitWarning('Something happened!', {
                  *   code: 'MY_WARNING',
-                 *   detail: 'This is some additional information'
+                 *   detail: 'This is some additional information',
                  * });
                  * // Emits:
                  * // (node:56338) [MY_WARNING] Warning: Something happened!
@@ -447,7 +447,7 @@ declare module 'process' {
                  * In this example, an `Error` object is generated internally by`process.emitWarning()` and passed through to the `'warning'` handler.
                  *
                  * ```js
-                 * import process from 'process';
+                 * import process from 'node:process';
                  *
                  * process.on('warning', (warning) => {
                  *   console.warn(warning.name);    // 'Warning'
@@ -499,7 +499,7 @@ declare module 'process' {
                  * While the following will:
                  *
                  * ```js
-                 * import { env } from 'process';
+                 * import { env } from 'node:process';
                  *
                  * env.foo = 'bar';
                  * console.log(env.foo);
@@ -510,7 +510,7 @@ declare module 'process' {
                  * throw an error when the value is not a string, number, or boolean.
                  *
                  * ```js
-                 * import { env } from 'process';
+                 * import { env } from 'node:process';
                  *
                  * env.test = null;
                  * console.log(env.test);
@@ -523,7 +523,7 @@ declare module 'process' {
                  * Use `delete` to delete a property from `process.env`.
                  *
                  * ```js
-                 * import { env } from 'process';
+                 * import { env } from 'node:process';
                  *
                  * env.TEST = 1;
                  * delete env.TEST;
@@ -534,7 +534,7 @@ declare module 'process' {
                  * On Windows operating systems, environment variables are case-insensitive.
                  *
                  * ```js
-                 * import { env } from 'process';
+                 * import { env } from 'node:process';
                  *
                  * env.TEST = 1;
                  * console.log(env.test);
@@ -543,7 +543,7 @@ declare module 'process' {
                  *
                  * Unless explicitly specified when creating a `Worker` instance,
                  * each `Worker` thread has its own copy of `process.env`, based on its
-                 * parent thread’s `process.env`, or whatever was specified as the `env` option
+                 * parent thread's `process.env`, or whatever was specified as the `env` option
                  * to the `Worker` constructor. Changes to `process.env` will not be visible
                  * across `Worker` threads, and only the main thread can make changes that
                  * are visible to the operating system or to native add-ons.
@@ -560,7 +560,7 @@ declare module 'process' {
                  * To exit with a 'failure' code:
                  *
                  * ```js
-                 * import { exit } from 'process';
+                 * import { exit } from 'node:process';
                  *
                  * exit(1);
                  * ```
@@ -579,7 +579,7 @@ declare module 'process' {
                  * truncated and lost:
                  *
                  * ```js
-                 * import { exit } from 'process';
+                 * import { exit } from 'node:process';
                  *
                  * // This is an example of what *not* to do:
                  * if (someConditionNotMet()) {
@@ -596,7 +596,7 @@ declare module 'process' {
                  * scheduling any additional work for the event loop:
                  *
                  * ```js
-                 * import process from 'process';
+                 * import process from 'node:process';
                  *
                  * // How to properly set the exit code while letting
                  * // the process exit gracefully.
@@ -613,7 +613,7 @@ declare module 'process' {
                  * In `Worker` threads, this function stops the current thread rather
                  * than the current process.
                  * @since v0.1.13
-                 * @param [code=0] The exit code.
+                 * @param [code=0] The exit code. For string type, only integer strings (e.g.,'1') are allowed.
                  */
                 exit(code?: number): never;
                 /**
@@ -873,7 +873,7 @@ declare module 'process' {
                  * The `process.version` property contains the Node.js version string.
                  *
                  * ```js
-                 * import { version } from 'process';
+                 * import { version } from 'node:process';
                  *
                  * console.log(`Version: ${version}`);
                  * // Version: v14.8.0
@@ -890,7 +890,7 @@ declare module 'process' {
                  * to load modules that were compiled against a different module ABI version.
                  *
                  * ```js
-                 * import { versions } from 'process';
+                 * import { versions } from 'node:process';
                  *
                  * console.log(versions);
                  * ```
@@ -918,10 +918,10 @@ declare module 'process' {
                  */
                 readonly versions: ProcessVersions;
                 /**
-                 * The `process.config` property returns an `Object` containing the JavaScript
-                 * representation of the configure options used to compile the current Node.js
-                 * executable. This is the same as the `config.gypi` file that was produced when
-                 * running the `./configure` script.
+                 * The `process.config` property returns a frozen `Object` containing the
+                 * JavaScript representation of the configure options used to compile the current
+                 * Node.js executable. This is the same as the `config.gypi` file that was produced
+                 * when running the `./configure` script.
                  *
                  * An example of the possible output looks like:
                  *
@@ -943,7 +943,6 @@ declare module 'process' {
                  *      node_shared_http_parser: 'false',
                  *      node_shared_libuv: 'false',
                  *      node_shared_zlib: 'false',
-                 *      node_use_dtrace: 'false',
                  *      node_use_openssl: 'true',
                  *      node_shared_openssl: 'false',
                  *      strict_aliasing: 'true',
@@ -952,13 +951,6 @@ declare module 'process' {
                  *    }
                  * }
                  * ```
-                 *
-                 * The `process.config` property is **not** read-only and there are existing
-                 * modules in the ecosystem that are known to extend, modify, or entirely replace
-                 * the value of `process.config`.
-                 *
-                 * Modifying the `process.config` property, or any child-property of the`process.config` object has been deprecated. The `process.config` will be made
-                 * read-only in a future release.
                  * @since v0.7.7
                  */
                 readonly config: ProcessConfig;
@@ -977,7 +969,7 @@ declare module 'process' {
                  * other than kill the target process.
                  *
                  * ```js
-                 * import process, { kill } from 'process';
+                 * import process, { kill } from 'node:process';
                  *
                  * process.on('SIGHUP', () => {
                  *   console.log('Got SIGHUP signal.');
@@ -1002,7 +994,7 @@ declare module 'process' {
                  * The `process.pid` property returns the PID of the process.
                  *
                  * ```js
-                 * import { pid } from 'process';
+                 * import { pid } from 'node:process';
                  *
                  * console.log(`This process is pid ${pid}`);
                  * ```
@@ -1014,7 +1006,7 @@ declare module 'process' {
                  * current process.
                  *
                  * ```js
-                 * import { ppid } from 'process';
+                 * import { ppid } from 'node:process';
                  *
                  * console.log(`The parent process is pid ${ppid}`);
                  * ```
@@ -1044,7 +1036,7 @@ declare module 'process' {
                  * Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,`'ppc64'`, `'s390'`, `'s390x'`, and `'x64'`.
                  *
                  * ```js
-                 * import { arch } from 'process';
+                 * import { arch } from 'node:process';
                  *
                  * console.log(`This processor architecture is ${arch}`);
                  * ```
@@ -1066,7 +1058,7 @@ declare module 'process' {
                  * * `'win32'`
                  *
                  * ```js
-                 * import { platform } from 'process';
+                 * import { platform } from 'node:process';
                  *
                  * console.log(`This platform is ${platform}`);
                  * ```
@@ -1093,6 +1085,11 @@ declare module 'process' {
                  * Gets the amount of memory available to the process (in bytes) based on
                  * limits imposed by the OS. If there is no such constraint, or the constraint
                  * is unknown, `undefined` is returned.
+                 *
+                 * See [`uv_get_constrained_memory`](https://docs.libuv.org/en/v1.x/misc.html#c.uv_get_constrained_memory) for more
+                 * information.
+                 * @since v19.6.0, v18.15.0
+                 * @experimental
                  */
                 constrainedMemory(): number | undefined;
                 /**
@@ -1106,7 +1103,7 @@ declare module 'process' {
                  * argument to the function, to get a diff reading.
                  *
                  * ```js
-                 * import { cpuUsage } from 'process';
+                 * import { cpuUsage } from 'node:process';
                  *
                  * const startUsage = cpuUsage();
                  * // { user: 38579, system: 6986 }
@@ -1130,7 +1127,7 @@ declare module 'process' {
                  * See the [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#process-nexttick) guide for more background.
                  *
                  * ```js
-                 * import { nextTick } from 'process';
+                 * import { nextTick } from 'node:process';
                  *
                  * console.log('start');
                  * nextTick(() => {
@@ -1148,7 +1145,7 @@ declare module 'process' {
                  * I/O has occurred:
                  *
                  * ```js
-                 * import { nextTick } from 'process';
+                 * import { nextTick } from 'node:process';
                  *
                  * function MyThing(options) {
                  *   this.setupOptions(options);
@@ -1196,7 +1193,7 @@ declare module 'process' {
                  * The following approach is much better:
                  *
                  * ```js
-                 * import { nextTick } from 'process';
+                 * import { nextTick } from 'node:process';
                  *
                  * function definitelyAsync(arg, cb) {
                  *   if (arg) {
@@ -1221,10 +1218,10 @@ declare module 'process' {
                  * ```js
                  * {
                  *   name: 'node',
-                 *   lts: 'Erbium',
-                 *   sourceUrl: 'https://nodejs.org/download/release/v12.18.1/node-v12.18.1.tar.gz',
-                 *   headersUrl: 'https://nodejs.org/download/release/v12.18.1/node-v12.18.1-headers.tar.gz',
-                 *   libUrl: 'https://nodejs.org/download/release/v12.18.1/win-x64/node.lib'
+                 *   lts: 'Hydrogen',
+                 *   sourceUrl: 'https://nodejs.org/download/release/v18.12.0/node-v18.12.0.tar.gz',
+                 *   headersUrl: 'https://nodejs.org/download/release/v18.12.0/node-v18.12.0-headers.tar.gz',
+                 *   libUrl: 'https://nodejs.org/download/release/v18.12.0/win-x64/node.lib'
                  * }
                  * ```
                  *
@@ -1328,7 +1325,7 @@ declare module 'process' {
                  * dashes:
                  *
                  * ```js
-                 * import { allowedNodeEnvironmentFlags } from 'process';
+                 * import { allowedNodeEnvironmentFlags } from 'node:process';
                  *
                  * allowedNodeEnvironmentFlags.forEach((flag) => {
                  *   // -r
@@ -1354,7 +1351,7 @@ declare module 'process' {
                 report?: ProcessReport | undefined;
                 /**
                  * ```js
-                 * import { resourceUsage } from 'process';
+                 * import { resourceUsage } from 'node:process';
                  *
                  * console.log(resourceUsage());
                  * /*

node/punycode.d.ts

@@ -24,7 +24,7 @@
  * made available to developers as a convenience. Fixes or other modifications to
  * the module must be directed to the [Punycode.js](https://github.com/bestiejs/punycode.js) project.
  * @deprecated Since v7.0.0 - Deprecated
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/punycode.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.0.0/lib/punycode.js)
  */
 declare module 'punycode' {
     /**

node/querystring.d.ts

@@ -1,15 +1,15 @@
 /**
- * The `querystring` module provides utilities for parsing and formatting URL
+ * The `node:querystring` module provides utilities for parsing and formatting URL
  * query strings. It can be accessed using:
  *
  * ```js
- * const querystring = require('querystring');
+ * const querystring = require('node:querystring');
  * ```
  *
  * `querystring` is more performant than `URLSearchParams` but is not a
- * standardized API. Use `URLSearchParams` when performance is not critical
- * or when compatibility with browser code is desirable.
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/querystring.js)
+ * standardized API. Use `URLSearchParams` when performance is not critical or
+ * when compatibility with browser code is desirable.
+ * @see [source](https://github.com/nodejs/node/blob/v20.0.0/lib/querystring.js)
  */
 declare module 'querystring' {
     interface StringifyOptions {

node/readline/promises.d.ts

@@ -7,7 +7,6 @@
 declare module 'readline/promises' {
     import { Interface as _Interface, ReadLineOptions, Completer, AsyncCompleter, Direction } from 'node:readline';
     import { Abortable } from 'node:events';
-
     class Interface extends _Interface {
         /**
          * The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input,
@@ -45,12 +44,16 @@ declare module 'readline/promises' {
         question(query: string): Promise<string>;
         question(query: string, options: Abortable): Promise<string>;
     }
-
     class Readline {
         /**
          * @param stream A TTY stream.
          */
-        constructor(stream: NodeJS.WritableStream, options?: { autoCommit?: boolean });
+        constructor(
+            stream: NodeJS.WritableStream,
+            options?: {
+                autoCommit?: boolean;
+            }
+        );
         /**
          * The `rl.clearLine()` method adds to the internal list of pending action an action that clears current line of the associated `stream` in a specified direction identified by `dir`.
          * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
@@ -80,7 +83,6 @@ declare module 'readline/promises' {
          */
         rollback(): this;
     }
-
     /**
      * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
      *

node/readline.d.ts

@@ -1,5 +1,5 @@
 /**
- * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time.
+ * The `node:readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time.
  *
  * To use the promise-based APIs:
  *
@@ -13,7 +13,7 @@
  * import * as readline from 'node:readline';
  * ```
  *
- * The following simple example illustrates the basic use of the `readline` module.
+ * The following simple example illustrates the basic use of the `node:readline`module.
  *
  * ```js
  * import * as readline from 'node:readline/promises';
@@ -30,7 +30,7 @@
  *
  * Once this code is invoked, the Node.js application will not terminate until the`readline.Interface` is closed because the interface waits for data to be
  * received on the `input` stream.
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.0.0/lib/readline.js)
  */
 declare module 'readline' {
     import { Abortable, EventEmitter } from 'node:events';
@@ -408,11 +408,11 @@ declare module 'readline' {
      * implement a small command-line interface:
      *
      * ```js
-     * const readline = require('readline');
+     * const readline = require('node:readline');
      * const rl = readline.createInterface({
      *   input: process.stdin,
      *   output: process.stdout,
-     *   prompt: 'OHAI> '
+     *   prompt: 'OHAI> ',
      * });
      *
      * rl.prompt();
@@ -440,15 +440,15 @@ declare module 'readline' {
      * well as a `for await...of` loop:
      *
      * ```js
-     * const fs = require('fs');
-     * const readline = require('readline');
+     * const fs = require('node:fs');
+     * const readline = require('node:readline');
      *
      * async function processLineByLine() {
      *   const fileStream = fs.createReadStream('input.txt');
      *
      *   const rl = readline.createInterface({
      *     input: fileStream,
-     *     crlfDelay: Infinity
+     *     crlfDelay: Infinity,
      *   });
      *   // Note: we use the crlfDelay option to recognize all instances of CR LF
      *   // ('\r\n') in input.txt as a single line break.
@@ -465,12 +465,12 @@ declare module 'readline' {
      * Alternatively, one could use the `'line'` event:
      *
      * ```js
-     * const fs = require('fs');
-     * const readline = require('readline');
+     * const fs = require('node:fs');
+     * const readline = require('node:readline');
      *
      * const rl = readline.createInterface({
      *   input: fs.createReadStream('sample.txt'),
-     *   crlfDelay: Infinity
+     *   crlfDelay: Infinity,
      * });
      *
      * rl.on('line', (line) => {
@@ -481,15 +481,15 @@ declare module 'readline' {
      * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied:
      *
      * ```js
-     * const { once } = require('events');
-     * const { createReadStream } = require('fs');
-     * const { createInterface } = require('readline');
+     * const { once } = require('node:events');
+     * const { createReadStream } = require('node:fs');
+     * const { createInterface } = require('node:readline');
      *
      * (async function processLineByLine() {
      *   try {
      *     const rl = createInterface({
      *       input: createReadStream('big-file.txt'),
-     *       crlfDelay: Infinity
+     *       crlfDelay: Infinity,
      *     });
      *
      *     rl.on('line', (line) => {