@types/node 17.0.44 → 18.0.0

node/url.d.ts

@@ -5,7 +5,7 @@
  * ```js
  * import url from 'url';
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/url.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/url.js)
  */
 declare module 'url' {
     import { Blob } from 'node:buffer';
@@ -205,7 +205,7 @@ declare module 'url' {
     function format(urlObject: UrlObject | string): string;
     /**
      * The `url.resolve()` method resolves a target URL relative to a base URL in a
-     * manner similar to that of a Web browser resolving an anchor tag HREF.
+     * manner similar to that of a web browser resolving an anchor tag.
      *
      * ```js
      * const url = require('url');
@@ -214,7 +214,7 @@ declare module 'url' {
      * url.resolve('http://example.com/one', '/two'); // 'http://example.com/two'
      * ```
      *
-     * You can achieve the same result using the WHATWG URL API:
+     * To achieve the same result using the WHATWG URL API:
      *
      * ```js
      * function resolve(from, to) {
@@ -233,8 +233,8 @@ declare module 'url' {
      * ```
      * @since v0.1.25
      * @deprecated Legacy: Use the WHATWG URL API instead.
-     * @param from The Base URL being resolved against.
-     * @param to The HREF URL being resolved.
+     * @param from The base URL to use if `to` is a relative URL.
+     * @param to The target URL to resolve.
      */
     function resolve(from: string, to: string): string;
     /**
@@ -332,7 +332,7 @@ declare module 'url' {
      * const myURL = new URL('https://a:b@測試?abc#foo');
      *
      * console.log(urlToHttpOptions(myURL));
-     *
+     * /*
      * {
      *   protocol: 'https:',
      *   hostname: 'xn--g6w251d',
@@ -397,7 +397,8 @@ declare module 'url' {
          */
         static createObjectURL(blob: Blob): string;
         /**
-         * Removes the stored `Blob` identified by the given ID.
+         * Removes the stored `Blob` identified by the given ID. Attempting to revoke a
+         * 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()`.
@@ -859,7 +860,6 @@ declare module 'url' {
         values(): IterableIterator<string>;
         [Symbol.iterator](): IterableIterator<[string, string]>;
     }
-
     import { URL as _URL, URLSearchParams as _URLSearchParams } from 'url';
     global {
         interface URLSearchParams extends _URLSearchParams {}
@@ -873,21 +873,23 @@ declare module 'url' {
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
-        var URL:
-            // For compatibility with "dom" and "webworker" URL declarations
-            typeof globalThis extends { onmessage: any, URL: infer URL }
-                ? URL
-                : typeof _URL;
+        var URL: typeof globalThis extends {
+            onmessage: any;
+            URL: infer URL;
+        }
+            ? URL
+            : typeof _URL;
         /**
          * `URLSearchParams` class is a global reference for `require('url').URLSearchParams`
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */
-        var URLSearchParams:
-            // For compatibility with "dom" and "webworker" URLSearchParams declarations
-            typeof globalThis extends { onmessage: any, URLSearchParams: infer URLSearchParams }
-                ? URLSearchParams
-                : typeof _URLSearchParams;
+        var URLSearchParams: typeof globalThis extends {
+            onmessage: any;
+            URLSearchParams: infer URLSearchParams;
+        }
+            ? URLSearchParams
+            : typeof _URLSearchParams;
     }
 }
 declare module 'node:url' {

node/util.d.ts

@@ -6,7 +6,7 @@
  * ```js
  * const util = require('util');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/util.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/util.js)
  */
 declare module 'util' {
     import * as types from 'node:util/types';
@@ -309,6 +309,21 @@ declare module 'util' {
      * );
      * ```
      *
+     * The `numericSeparator` option adds an underscore every three digits to all
+     * numbers.
+     *
+     * ```js
+     * const { inspect } = require('util');
+     *
+     * const thousand = 1_000;
+     * const million = 1_000_000;
+     * const bigNumber = 123_456_789n;
+     * const bigDecimal = 1_234.123_45;
+     *
+     * console.log(thousand, million, bigNumber, bigDecimal);
+     * // 1_000 1_000_000 123_456_789n 1_234.123_45
+     * ```
+     *
      * `util.inspect()` is a synchronous method intended for debugging. Its maximum
      * output length is approximately 128 MB. Inputs that result in longer output will
      * be truncated.
@@ -859,7 +874,7 @@ declare module 'util' {
      * callbackFunction((err, ret) => {
      *   // When the Promise was rejected with `null` it is wrapped with an Error and
      *   // the original value is stored in `reason`.
-     *   err && err.hasOwnProperty('reason') && err.reason === null;  // true
+     *   err && Object.hasOwn(err, 'reason') && err.reason === null;  // true
      * });
      * ```
      * @since v8.2.0
@@ -998,13 +1013,9 @@ declare module 'util' {
      * An implementation of the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) `TextDecoder` API.
      *
      * ```js
-     * const decoder = new TextDecoder('shift_jis');
-     * let string = '';
-     * let buffer;
-     * while (buffer = getNextChunkSomehow()) {
-     *   string += decoder.decode(buffer, { stream: true });
-     * }
-     * string += decoder.decode(); // end-of-stream
+     * const decoder = new TextDecoder();
+     * const u8arr = new Uint8Array([72, 101, 108, 108, 111]);
+     * console.log(decoder.decode(u8arr)); // Hello
      * ```
      * @since v8.3.0
      */

node/v8.d.ts

@@ -4,7 +4,7 @@
  * ```js
  * const v8 = require('v8');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/v8.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/v8.js)
  */
 declare module 'v8' {
     import { Readable } from 'node:stream';
@@ -163,6 +163,13 @@ declare module 'v8' {
      * Chrome DevTools. The JSON schema is undocumented and specific to the
      * V8 engine. Therefore, the schema may change from one version of V8 to the next.
      *
+     * Creating a heap snapshot requires memory about twice the size of the heap at
+     * the time the snapshot is created. This results in the risk of OOM killers
+     * terminating the process.
+     *
+     * Generating a snapshot is a synchronous operation which blocks the event loop
+     * for a duration depending on the heap size.
+     *
      * ```js
      * // Print heap snapshot to the console
      * const v8 = require('v8');
@@ -182,6 +189,13 @@ declare module 'v8' {
      * A heap snapshot is specific to a single V8 isolate. When using `worker threads`, a heap snapshot generated from the main thread will
      * not contain any information about the workers, and vice versa.
      *
+     * Creating a heap snapshot requires memory about twice the size of the heap at
+     * the time the snapshot is created. This results in the risk of OOM killers
+     * terminating the process.
+     *
+     * Generating a snapshot is a synchronous operation which blocks the event loop
+     * for a duration depending on the heap size.
+     *
      * ```js
      * const { writeHeapSnapshot } = require('v8');
      * const {
@@ -344,6 +358,10 @@ declare module 'v8' {
     class DefaultDeserializer extends Deserializer {}
     /**
      * Uses a `DefaultSerializer` to serialize `value` into a buffer.
+     *
+     * `ERR_BUFFER_TOO_LARGE` will be thrown when trying to
+     * serialize a huge object which requires buffer
+     * larger than `buffer.constants.MAX_LENGTH`.
      * @since v8.0.0
      */
     function serialize(value: any): Buffer;

node/vm.d.ts

@@ -1,7 +1,9 @@
 /**
  * The `vm` module enables compiling and running code within V8 Virtual
- * Machine contexts. **The `vm` module is not a security mechanism. Do**
- * **not use it to run untrusted code.**
+ * Machine contexts.
+ *
+ * **The `vm` module is not a security**
+ * **mechanism. Do not use it to run untrusted code.**
  *
  * JavaScript code can be compiled and run immediately or
  * compiled, saved, and run later.
@@ -32,7 +34,7 @@
  *
  * console.log(x); // 1; y is not defined.
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/vm.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/vm.js)
  */
 declare module 'vm' {
     interface Context extends NodeJS.Dict<any> {}

node/wasi.d.ts

@@ -68,7 +68,7 @@
  * The `--experimental-wasi-unstable-preview1` CLI argument is needed for this
  * example to run.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/wasi.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/wasi.js)
  */
 declare module 'wasi' {
     interface WASIOptions {

node/worker_threads.d.ts

@@ -39,7 +39,7 @@
  * }
  * ```
  *
- * The above example spawns a Worker thread for each `parse()` call. In actual
+ * The above example spawns a Worker thread for each `parseJSAsync()` call. In
  * practice, use a pool of Workers for these kinds of tasks. Otherwise, the
  * overhead of creating Workers would likely exceed their benefit.
  *
@@ -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/v17.0.0/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';
@@ -507,7 +507,6 @@ declare module 'worker_threads' {
      * }
      * ```
      * @since v15.4.0
-     * @experimental
      */
     class BroadcastChannel {
         readonly name: string;
@@ -630,14 +629,12 @@ declare module 'worker_threads' {
      * }
      * ```
      * @since v15.12.0, v14.18.0
-     * @experimental
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      */
     function getEnvironmentData(key: Serializable): Serializable;
     /**
      * The `worker.setEnvironmentData()` API sets the content of`worker.getEnvironmentData()` in the current thread and all new `Worker`instances spawned from the current context.
      * @since v15.12.0, v14.18.0
-     * @experimental
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      * @param value Any arbitrary, cloneable JavaScript value that will be cloned and passed automatically to all new `Worker` instances. If `value` is passed as `undefined`, any previously set value
      * for the `key` will be deleted.

node/zlib.d.ts

@@ -88,7 +88,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/zlib.js)
  */
 declare module 'zlib' {
     import * as stream from 'node:stream';