@types/node 18.16.5 → 20.1.0

node v18.16/ts4.8/worker_threads.d.ts → node/ts4.8/worker_threads.d.ts

@@ -1,9 +1,9 @@
 /**
- * The `worker_threads` module enables the use of threads that execute JavaScript
- * in parallel. To access it:
+ * The `node:worker_threads` module enables the use of threads that execute
+ * JavaScript in parallel. To access it:
  *
  * ```js
- * const worker = require('worker_threads');
+ * const worker = require('node:worker_threads');
  * ```
  *
  * Workers (threads) are useful for performing CPU-intensive JavaScript operations.
@@ -15,14 +15,14 @@
  *
  * ```js
  * const {
- *   Worker, isMainThread, parentPort, workerData
- * } = require('worker_threads');
+ *   Worker, isMainThread, parentPort, workerData,
+ * } = require('node:worker_threads');
  *
  * if (isMainThread) {
  *   module.exports = function parseJSAsync(script) {
  *     return new Promise((resolve, reject) => {
  *       const worker = new Worker(__filename, {
- *         workerData: script
+ *         workerData: script,
  *       });
  *       worker.on('message', resolve);
  *       worker.on('error', reject);
@@ -49,7 +49,7 @@
  *
  * Worker threads inherit non-process-specific options by default. Refer to `Worker constructor options` to know how to customize worker thread options,
  * specifically `argv` and `execArgv` options.
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.1.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';
@@ -72,7 +72,7 @@ declare module 'worker_threads' {
      * The `MessageChannel` has no methods of its own. `new MessageChannel()`yields an object with `port1` and `port2` properties, which refer to linked `MessagePort` instances.
      *
      * ```js
-     * const { MessageChannel } = require('worker_threads');
+     * const { MessageChannel } = require('node:worker_threads');
      *
      * const { port1, port2 } = new MessageChannel();
      * port1.on('message', (message) => console.log('received', message));
@@ -121,7 +121,7 @@ declare module 'worker_threads' {
          * * `value` may not contain native (C++-backed) objects other than:
          *
          * ```js
-         * const { MessageChannel } = require('worker_threads');
+         * const { MessageChannel } = require('node:worker_threads');
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -132,7 +132,7 @@ declare module 'worker_threads' {
          * port2.postMessage(circularData);
          * ```
          *
-         * `transferList` may be a list of [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), `MessagePort` and `FileHandle` objects.
+         * `transferList` may be a list of [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), `MessagePort`, and `FileHandle` objects.
          * After transferring, they are not usable on the sending side of the channel
          * anymore (even if they are not contained in `value`). Unlike with `child processes`, transferring handles such as network sockets is currently
          * not supported.
@@ -143,7 +143,7 @@ declare module 'worker_threads' {
          * `value` may still contain `ArrayBuffer` instances that are not in`transferList`; in that case, the underlying memory is copied rather than moved.
          *
          * ```js
-         * const { MessageChannel } = require('worker_threads');
+         * const { MessageChannel } = require('node:worker_threads');
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -170,7 +170,7 @@ declare module 'worker_threads' {
          * posting without having side effects.
          *
          * For more information on the serialization and deserialization mechanisms
-         * behind this API, see the `serialization API of the v8 module`.
+         * behind this API, see the `serialization API of the node:v8 module`.
          * @since v10.5.0
          */
         postMessage(value: any, transferList?: ReadonlyArray<TransferListItem>): void;
@@ -294,9 +294,9 @@ declare module 'worker_threads' {
      *
      * Notable differences inside a Worker environment are:
      *
-     * * The `process.stdin`, `process.stdout` and `process.stderr` may be redirected by the parent thread.
-     * * The `require('worker_threads').isMainThread` property is set to `false`.
-     * * The `require('worker_threads').parentPort` message port is available.
+     * * The `process.stdin`, `process.stdout`, and `process.stderr` streams may be redirected by the parent thread.
+     * * The `require('node:worker_threads').isMainThread` property is set to `false`.
+     * * The `require('node:worker_threads').parentPort` message port is available.
      * * `process.exit()` does not stop the whole program, just the single thread,
      * and `process.abort()` is not available.
      * * `process.chdir()` and `process` methods that set group or user ids
@@ -313,11 +313,11 @@ declare module 'worker_threads' {
      *
      * Creating `Worker` instances inside of other `Worker`s is possible.
      *
-     * Like [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) and the `cluster module`, two-way communication can be
-     * achieved through inter-thread message passing. Internally, a `Worker` has a
-     * built-in pair of `MessagePort` s that are already associated with each other
-     * when the `Worker` is created. While the `MessagePort` object on the parent side
-     * is not directly exposed, its functionalities are exposed through `worker.postMessage()` and the `worker.on('message')` event
+     * Like [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) and the `node:cluster module`, two-way communication
+     * can be achieved through inter-thread message passing. Internally, a `Worker` has
+     * a built-in pair of `MessagePort` s that are already associated with each
+     * other when the `Worker` is created. While the `MessagePort` object on the parent
+     * side is not directly exposed, its functionalities are exposed through `worker.postMessage()` and the `worker.on('message')` event
      * on the `Worker` object for the parent thread.
      *
      * To create custom messaging channels (which is encouraged over using the default
@@ -330,10 +330,10 @@ declare module 'worker_threads' {
      * the thread barrier.
      *
      * ```js
-     * const assert = require('assert');
+     * const assert = require('node:assert');
      * const {
-     *   Worker, MessageChannel, MessagePort, isMainThread, parentPort
-     * } = require('worker_threads');
+     *   Worker, MessageChannel, MessagePort, isMainThread, parentPort,
+     * } = require('node:worker_threads');
      * if (isMainThread) {
      *   const worker = new Worker(__filename);
      *   const subChannel = new MessageChannel();
@@ -373,7 +373,7 @@ declare module 'worker_threads' {
         readonly stderr: Readable;
         /**
          * An integer identifier for the referenced thread. Inside the worker thread,
-         * it is available as `require('worker_threads').threadId`.
+         * it is available as `require('node:worker_threads').threadId`.
          * This value is unique for each `Worker` instance inside a single process.
          * @since v10.5.0
          */
@@ -400,7 +400,7 @@ declare module 'worker_threads' {
          */
         constructor(filename: string | URL, options?: WorkerOptions);
         /**
-         * Send a message to the worker that is received via `require('worker_threads').parentPort.on('message')`.
+         * Send a message to the worker that is received via `require('node:worker_threads').parentPort.on('message')`.
          * See `port.postMessage()` for more details.
          * @since v10.5.0
          */
@@ -494,8 +494,8 @@ declare module 'worker_threads' {
      * const {
      *   isMainThread,
      *   BroadcastChannel,
-     *   Worker
-     * } = require('worker_threads');
+     *   Worker,
+     * } = require('node:worker_threads');
      *
      * const bc = new BroadcastChannel('hello');
      *
@@ -549,7 +549,7 @@ declare module 'worker_threads' {
      * This operation cannot be undone.
      *
      * ```js
-     * const { MessageChannel, markAsUntransferable } = require('worker_threads');
+     * const { MessageChannel, markAsUntransferable } = require('node:worker_threads');
      *
      * const pooledBuffer = new ArrayBuffer(8);
      * const typedArray1 = new Uint8Array(pooledBuffer);
@@ -591,10 +591,10 @@ declare module 'worker_threads' {
     function moveMessagePortToContext(port: MessagePort, contextifiedSandbox: Context): MessagePort;
     /**
      * Receive a single message from a given `MessagePort`. If no message is available,`undefined` is returned, otherwise an object with a single `message` property
-     * that contains the message payload, corresponding to the oldest message in the`MessagePort`’s queue.
+     * that contains the message payload, corresponding to the oldest message in the`MessagePort`'s queue.
      *
      * ```js
-     * const { MessageChannel, receiveMessageOnPort } = require('worker_threads');
+     * const { MessageChannel, receiveMessageOnPort } = require('node:worker_threads');
      * const { port1, port2 } = new MessageChannel();
      * port1.postMessage({ hello: 'world' });
      *
@@ -625,7 +625,7 @@ declare module 'worker_threads' {
      *   isMainThread,
      *   setEnvironmentData,
      *   getEnvironmentData,
-     * } = require('worker_threads');
+     * } = require('node:worker_threads');
      *
      * if (isMainThread) {
      *   setEnvironmentData('Hello', 'World!');
@@ -664,7 +664,6 @@ declare module 'worker_threads' {
         }
             ? T
             : typeof _BroadcastChannel;
-
         /**
          * `MessageChannel` class is a global reference for `require('worker_threads').MessageChannel`
          * https://nodejs.org/api/globals.html#messagechannel
@@ -676,13 +675,12 @@ declare module 'worker_threads' {
         }
             ? T
             : typeof _MessageChannel;
-
         /**
          * `MessagePort` class is a global reference for `require('worker_threads').MessagePort`
          * https://nodejs.org/api/globals.html#messageport
          * @since v15.0.0
          */
-         var MessagePort: typeof globalThis extends {
+        var MessagePort: typeof globalThis extends {
             onmessage: any;
             MessagePort: infer T;
         }

node v18.16/zlib.d.ts → node/ts4.8/zlib.d.ts

@@ -1,11 +1,11 @@
 /**
- * The `zlib` module provides compression functionality implemented using Gzip,
- * Deflate/Inflate, and Brotli.
+ * The `node:zlib` module provides compression functionality implemented using
+ * Gzip, Deflate/Inflate, and Brotli.
  *
  * To access it:
  *
  * ```js
- * const zlib = require('zlib');
+ * const zlib = require('node:zlib');
  * ```
  *
  * Compression and decompression are built around the Node.js `Streams API`.
@@ -15,12 +15,12 @@
  * stream:
  *
  * ```js
- * const { createGzip } = require('zlib');
- * const { pipeline } = require('stream');
+ * const { createGzip } = require('node:zlib');
+ * const { pipeline } = require('node:stream');
  * const {
  *   createReadStream,
- *   createWriteStream
- * } = require('fs');
+ *   createWriteStream,
+ * } = require('node:fs');
  *
  * const gzip = createGzip();
  * const source = createReadStream('input.txt');
@@ -35,7 +35,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('util');
+ * const { promisify } = require('node:util');
  * const pipe = promisify(pipeline);
  *
  * async function do_gzip(input, output) {
@@ -55,7 +55,7 @@
  * It is also possible to compress or decompress data in a single step:
  *
  * ```js
- * const { deflate, unzip } = require('zlib');
+ * const { deflate, unzip } = require('node:zlib');
  *
  * const input = '.................................';
  * deflate(input, (err, buffer) => {
@@ -77,7 +77,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('util');
+ * const { promisify } = require('node:util');
  * const do_unzip = promisify(unzip);
  *
  * do_unzip(buffer)
@@ -88,7 +88,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.1.0/lib/zlib.js)
  */
 declare module 'zlib' {
     import * as stream from 'node:stream';

node v18.16/ts4.8/tty.d.ts → node/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 v18.16/url.d.ts → node/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;
         /**