@types/node 16.18.80 → 16.18.81

node v16.18/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v16.
 
 ### Additional Details
- * Last updated: Thu, 08 Feb 2024 20:35:44 GMT
+ * Last updated: Thu, 15 Feb 2024 10:07:24 GMT
  * Dependencies: none
 
 # Credits

node v16.18/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "16.18.80",
+    "version": "16.18.81",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -222,6 +222,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "0747ef1ff42367a2c659aab5fc827387e23d727f290cd39647ba32a7618902a6",
+    "typesPublisherContentHash": "ae03b227c3d602f42dd30296514410e0f03c04128303e667d569752dad86921f",
     "typeScriptVersion": "4.6"
 }

node v16.18/ts4.8/url.d.ts

@@ -5,7 +5,7 @@
  * ```js
  * import url from 'url';
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/url.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.20.2/lib/url.js)
  */
 declare module "url" {
     import { Blob } from "node:buffer";
@@ -104,18 +104,18 @@ declare module "url" {
      */
     function format(urlObject: URL, options?: URLFormatOptions): string;
     /**
-     * The `url.format()` method returns a formatted URL string derived from`urlObject`.
+     * 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'
@@ -130,33 +130,33 @@ declare module "url" {
      * * Otherwise, if `urlObject.protocol` is not `undefined` and is not a string, an `Error` is thrown.
      * * For all string values of `urlObject.protocol` that _do not end_ with an ASCII
      * colon (`:`) character, the literal string `:` will be appended to `result`.
-     * * If either of the following conditions is true, then the literal string `//`will be appended to `result`:
+     * * If either of the following conditions is true, then the literal string `//` will be appended to `result`:
      *    * `urlObject.slashes` property is true;
-     *    * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or`file`;
-     * * If the value of the `urlObject.auth` property is truthy, and either`urlObject.host` or `urlObject.hostname` are not `undefined`, the value of`urlObject.auth` will be coerced into a string
-     * and appended to `result`followed by the literal string `@`.
+     *    * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or `file`;
+     * * If the value of the `urlObject.auth` property is truthy, and either `urlObject.host` or `urlObject.hostname` are not `undefined`, the value of `urlObject.auth` will be coerced into a string
+     * and appended to `result` followed by the literal string `@`.
      * * If the `urlObject.host` property is `undefined` then:
      *    * If the `urlObject.hostname` is a string, it is appended to `result`.
      *    * Otherwise, if `urlObject.hostname` is not `undefined` and is not a string,
      *    an `Error` is thrown.
-     *    * If the `urlObject.port` property value is truthy, and `urlObject.hostname`is not `undefined`:
+     *    * If the `urlObject.port` property value is truthy, and `urlObject.hostname` is not `undefined`:
      *          * The literal string `:` is appended to `result`, and
-     *          * The value of `urlObject.port` is coerced to a string and appended to`result`.
-     * * Otherwise, if the `urlObject.host` property value is truthy, the value of`urlObject.host` is coerced to a string and appended to `result`.
+     *          * The value of `urlObject.port` is coerced to a string and appended to `result`.
+     * * Otherwise, if the `urlObject.host` property value is truthy, the value of `urlObject.host` is coerced to a string and appended to `result`.
      * * If the `urlObject.pathname` property is a string that is not an empty string:
-     *    * If the `urlObject.pathname`_does not start_ with an ASCII forward slash
+     *    * If the `urlObject.pathname` _does not start_ with an ASCII forward slash
      *    (`/`), then the literal string `'/'` is appended to `result`.
      *    * The value of `urlObject.pathname` is appended to `result`.
      * * Otherwise, if `urlObject.pathname` is not `undefined` and is not a string, an `Error` is thrown.
-     * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result`followed by the output of calling the
-     * `querystring` module's `stringify()`method passing the value of `urlObject.query`.
+     * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result` followed by the output of calling the
+     * `querystring` module's `stringify()` method passing the value of `urlObject.query`.
      * * Otherwise, if `urlObject.search` is a string:
-     *    * If the value of `urlObject.search`_does not start_ with the ASCII question
+     *    * If the value of `urlObject.search` _does not start_ with the ASCII question
      *    mark (`?`) character, the literal string `?` is appended to `result`.
      *    * The value of `urlObject.search` is appended to `result`.
      * * Otherwise, if `urlObject.search` is not `undefined` and is not a string, an `Error` is thrown.
      * * If the `urlObject.hash` property is a string:
-     *    * If the value of `urlObject.hash`_does not start_ with the ASCII hash (`#`)
+     *    * If the value of `urlObject.hash` _does not start_ with the ASCII hash (`#`)
      *    character, the literal string `#` is appended to `result`.
      *    * The value of `urlObject.hash` is appended to `result`.
      * * Otherwise, if the `urlObject.hash` property is not `undefined` and is not a
@@ -172,7 +172,7 @@ declare module "url" {
      * manner similar to that of a Web browser resolving an anchor tag HREF.
      *
      * ```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'
@@ -210,7 +210,7 @@ declare module "url" {
      * 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
@@ -231,7 +231,7 @@ declare module "url" {
      * 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
@@ -248,7 +248,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);
      *
@@ -274,7 +274,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)
@@ -292,7 +292,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));
@@ -315,9 +315,26 @@ declare module "url" {
      */
     function urlToHttpOptions(url: URL): ClientRequestArgs;
     interface URLFormatOptions {
+        /**
+         * `true` if the serialized URL string should include the username and password, `false` otherwise.
+         * @default true
+         */
         auth?: boolean | undefined;
+        /**
+         * `true` if the serialized URL string should include the fragment, `false` otherwise.
+         * @default true
+         */
         fragment?: boolean | undefined;
+        /**
+         * `true` if the serialized URL string should include the search query, `false` otherwise.
+         * @default true
+         */
         search?: boolean | undefined;
+        /**
+         * `true` if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to
+         * being Punycode encoded.
+         * @default false
+         */
         unicode?: boolean | undefined;
     }
     /**
@@ -340,7 +357,7 @@ declare module "url" {
          * const {
          *   Blob,
          *   resolveObjectURL,
-         * } = require('buffer');
+         * } = require('node:buffer');
          *
          * const blob = new Blob(['hello']);
          * const id = URL.createObjectURL(blob);
@@ -366,8 +383,8 @@ declare module "url" {
          * @experimental
          * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
          */
-        static revokeObjectURL(objectUrl: string): void;
-        constructor(input: string, base?: string | URL);
+        static revokeObjectURL(id: string): void;
+        constructor(input: string | { toString: () => string }, base?: string | URL);
         /**
          * Gets and sets the fragment portion of the URL.
          *
@@ -496,14 +513,14 @@ declare module "url" {
          * // Prints https://example.org/abcdef?123
          * ```
          *
-         * Invalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters
+         * Invalid URL characters included in the value assigned to the `pathname` property are `percent-encoded`. The selection of which characters
          * to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
          */
         pathname: string;
         /**
          * Gets and sets the port portion of the URL.
          *
-         * The port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will
+         * The port value may be a number or a string containing a number in the range `0` to `65535` (inclusive). Setting the value to the default port of the `URL` objects given `protocol` will
          * result in the `port` value becoming
          * the empty string (`''`).
          *
@@ -643,7 +660,7 @@ declare module "url" {
          * // Prints https://123:xyz@example.com/
          * ```
          *
-         * Any invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which
+         * Any invalid URL characters appearing in the value assigned the `username` property will be `percent-encoded`. The selection of which
          * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
          */
         username: string;
@@ -671,7 +688,7 @@ declare module "url" {
         toJSON(): string;
     }
     /**
-     * The `URLSearchParams` API provides read and write access to the query of a`URL`. The `URLSearchParams` class can also be used standalone with one of the
+     * The `URLSearchParams` API provides read and write access to the query of a `URL`. The `URLSearchParams` class can also be used standalone with one of the
      * four following constructors.
      * The `URLSearchParams` class is also available on the global object.
      *
@@ -755,7 +772,7 @@ declare module "url" {
          * @param thisArg To be used as `this` value for when `fn` is called
          */
         forEach<TThis = this>(
-            callback: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void,
+            fn: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void,
             thisArg?: TThis,
         ): void;
         /**

node v16.18/url.d.ts

@@ -5,7 +5,7 @@
  * ```js
  * import url from 'url';
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/url.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.20.2/lib/url.js)
  */
 declare module "url" {
     import { Blob } from "node:buffer";
@@ -104,18 +104,18 @@ declare module "url" {
      */
     function format(urlObject: URL, options?: URLFormatOptions): string;
     /**
-     * The `url.format()` method returns a formatted URL string derived from`urlObject`.
+     * 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'
@@ -130,33 +130,33 @@ declare module "url" {
      * * Otherwise, if `urlObject.protocol` is not `undefined` and is not a string, an `Error` is thrown.
      * * For all string values of `urlObject.protocol` that _do not end_ with an ASCII
      * colon (`:`) character, the literal string `:` will be appended to `result`.
-     * * If either of the following conditions is true, then the literal string `//`will be appended to `result`:
+     * * If either of the following conditions is true, then the literal string `//` will be appended to `result`:
      *    * `urlObject.slashes` property is true;
-     *    * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or`file`;
-     * * If the value of the `urlObject.auth` property is truthy, and either`urlObject.host` or `urlObject.hostname` are not `undefined`, the value of`urlObject.auth` will be coerced into a string
-     * and appended to `result`followed by the literal string `@`.
+     *    * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or `file`;
+     * * If the value of the `urlObject.auth` property is truthy, and either `urlObject.host` or `urlObject.hostname` are not `undefined`, the value of `urlObject.auth` will be coerced into a string
+     * and appended to `result` followed by the literal string `@`.
      * * If the `urlObject.host` property is `undefined` then:
      *    * If the `urlObject.hostname` is a string, it is appended to `result`.
      *    * Otherwise, if `urlObject.hostname` is not `undefined` and is not a string,
      *    an `Error` is thrown.
-     *    * If the `urlObject.port` property value is truthy, and `urlObject.hostname`is not `undefined`:
+     *    * If the `urlObject.port` property value is truthy, and `urlObject.hostname` is not `undefined`:
      *          * The literal string `:` is appended to `result`, and
-     *          * The value of `urlObject.port` is coerced to a string and appended to`result`.
-     * * Otherwise, if the `urlObject.host` property value is truthy, the value of`urlObject.host` is coerced to a string and appended to `result`.
+     *          * The value of `urlObject.port` is coerced to a string and appended to `result`.
+     * * Otherwise, if the `urlObject.host` property value is truthy, the value of `urlObject.host` is coerced to a string and appended to `result`.
      * * If the `urlObject.pathname` property is a string that is not an empty string:
-     *    * If the `urlObject.pathname`_does not start_ with an ASCII forward slash
+     *    * If the `urlObject.pathname` _does not start_ with an ASCII forward slash
      *    (`/`), then the literal string `'/'` is appended to `result`.
      *    * The value of `urlObject.pathname` is appended to `result`.
      * * Otherwise, if `urlObject.pathname` is not `undefined` and is not a string, an `Error` is thrown.
-     * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result`followed by the output of calling the
-     * `querystring` module's `stringify()`method passing the value of `urlObject.query`.
+     * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result` followed by the output of calling the
+     * `querystring` module's `stringify()` method passing the value of `urlObject.query`.
      * * Otherwise, if `urlObject.search` is a string:
-     *    * If the value of `urlObject.search`_does not start_ with the ASCII question
+     *    * If the value of `urlObject.search` _does not start_ with the ASCII question
      *    mark (`?`) character, the literal string `?` is appended to `result`.
      *    * The value of `urlObject.search` is appended to `result`.
      * * Otherwise, if `urlObject.search` is not `undefined` and is not a string, an `Error` is thrown.
      * * If the `urlObject.hash` property is a string:
-     *    * If the value of `urlObject.hash`_does not start_ with the ASCII hash (`#`)
+     *    * If the value of `urlObject.hash` _does not start_ with the ASCII hash (`#`)
      *    character, the literal string `#` is appended to `result`.
      *    * The value of `urlObject.hash` is appended to `result`.
      * * Otherwise, if the `urlObject.hash` property is not `undefined` and is not a
@@ -172,7 +172,7 @@ declare module "url" {
      * manner similar to that of a Web browser resolving an anchor tag HREF.
      *
      * ```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'
@@ -210,7 +210,7 @@ declare module "url" {
      * 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
@@ -231,7 +231,7 @@ declare module "url" {
      * 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
@@ -248,7 +248,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);
      *
@@ -274,7 +274,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)
@@ -292,7 +292,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));
@@ -315,9 +315,26 @@ declare module "url" {
      */
     function urlToHttpOptions(url: URL): ClientRequestArgs;
     interface URLFormatOptions {
+        /**
+         * `true` if the serialized URL string should include the username and password, `false` otherwise.
+         * @default true
+         */
         auth?: boolean | undefined;
+        /**
+         * `true` if the serialized URL string should include the fragment, `false` otherwise.
+         * @default true
+         */
         fragment?: boolean | undefined;
+        /**
+         * `true` if the serialized URL string should include the search query, `false` otherwise.
+         * @default true
+         */
         search?: boolean | undefined;
+        /**
+         * `true` if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to
+         * being Punycode encoded.
+         * @default false
+         */
         unicode?: boolean | undefined;
     }
     /**
@@ -340,7 +357,7 @@ declare module "url" {
          * const {
          *   Blob,
          *   resolveObjectURL,
-         * } = require('buffer');
+         * } = require('node:buffer');
          *
          * const blob = new Blob(['hello']);
          * const id = URL.createObjectURL(blob);
@@ -366,8 +383,8 @@ declare module "url" {
          * @experimental
          * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
          */
-        static revokeObjectURL(objectUrl: string): void;
-        constructor(input: string, base?: string | URL);
+        static revokeObjectURL(id: string): void;
+        constructor(input: string | { toString: () => string }, base?: string | URL);
         /**
          * Gets and sets the fragment portion of the URL.
          *
@@ -496,14 +513,14 @@ declare module "url" {
          * // Prints https://example.org/abcdef?123
          * ```
          *
-         * Invalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters
+         * Invalid URL characters included in the value assigned to the `pathname` property are `percent-encoded`. The selection of which characters
          * to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
          */
         pathname: string;
         /**
          * Gets and sets the port portion of the URL.
          *
-         * The port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will
+         * The port value may be a number or a string containing a number in the range `0` to `65535` (inclusive). Setting the value to the default port of the `URL` objects given `protocol` will
          * result in the `port` value becoming
          * the empty string (`''`).
          *
@@ -643,7 +660,7 @@ declare module "url" {
          * // Prints https://123:xyz@example.com/
          * ```
          *
-         * Any invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which
+         * Any invalid URL characters appearing in the value assigned the `username` property will be `percent-encoded`. The selection of which
          * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
          */
         username: string;
@@ -671,7 +688,7 @@ declare module "url" {
         toJSON(): string;
     }
     /**
-     * The `URLSearchParams` API provides read and write access to the query of a`URL`. The `URLSearchParams` class can also be used standalone with one of the
+     * The `URLSearchParams` API provides read and write access to the query of a `URL`. The `URLSearchParams` class can also be used standalone with one of the
      * four following constructors.
      * The `URLSearchParams` class is also available on the global object.
      *
@@ -755,7 +772,7 @@ declare module "url" {
          * @param thisArg To be used as `this` value for when `fn` is called
          */
         forEach<TThis = this>(
-            callback: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void,
+            fn: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void,
             thisArg?: TThis,
         ): void;
         /**