@types/node 16.4.14 → 16.7.0

node/timers/promises.d.ts

@@ -9,14 +9,6 @@
  *   setInterval,
  * } from 'timers/promises';
  * ```
- *
- * ```js
- * const {
- *   setTimeout,
- *   setImmediate,
- *   setInterval,
- * } = require('timers/promises');
- * ```
  * @since v15.0.0
  */
 declare module 'timers/promises' {
@@ -31,16 +23,6 @@ declare module 'timers/promises' {
      *
      * console.log(res);  // Prints 'result'
      * ```
-     *
-     * ```js
-     * const {
-     *   setTimeout,
-     * } = require('timers/promises');
-     *
-     * setTimeout(100, 'result').then((res) => {
-     *   console.log(res);  // Prints 'result'
-     * });
-     * ```
      * @since v15.0.0
      * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
      * @param value A value with which the promise is fulfilled.
@@ -56,16 +38,6 @@ declare module 'timers/promises' {
      *
      * console.log(res);  // Prints 'result'
      * ```
-     *
-     * ```js
-     * const {
-     *   setImmediate,
-     * } = require('timers/promises');
-     *
-     * setImmediate('result').then((res) => {
-     *   console.log(res);  // Prints 'result'
-     * });
-     * ```
      * @since v15.0.0
      * @param value A value with which the promise is fulfilled.
      */
@@ -87,23 +59,6 @@ declare module 'timers/promises' {
      * }
      * console.log(Date.now());
      * ```
-     *
-     * ```js
-     * const {
-     *   setInterval,
-     * } = require('timers/promises');
-     * const interval = 100;
-     *
-     * (async function() {
-     *   for await (const startTime of setInterval(interval, Date.now())) {
-     *     const now = Date.now();
-     *     console.log(now);
-     *     if ((now - startTime) > 1000)
-     *       break;
-     *   }
-     *   console.log(Date.now());
-     * })();
-     * ```
      * @since v15.9.0
      */
     function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;

node/timers.d.ts

@@ -6,7 +6,7 @@
  * 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/v16.4.2/lib/timers.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/timers.js)
  */
 declare module 'timers' {
     import { Abortable } from 'node:events';

node/tls.d.ts

@@ -6,7 +6,7 @@
  * ```js
  * const tls = require('tls');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/tls.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/tls.js)
  */
 declare module 'tls' {
     import { X509Certificate } from 'node:crypto';
@@ -348,14 +348,14 @@ declare module 'tls' {
          */
         enableTrace(): void;
         /**
-         * Returns the peer certificate as an `<X509Certificate>` object.
+         * Returns the peer certificate as an `X509Certificate` object.
          *
          * If there is no peer certificate, or the socket has been destroyed,`undefined` will be returned.
          * @since v15.9.0
          */
         getPeerX509Certificate(): X509Certificate | undefined;
         /**
-         * Returns the local certificate as an `<X509Certificate>` object.
+         * Returns the local certificate as an `X509Certificate` object.
          *
          * If there is no local certificate, or the socket has been destroyed,`undefined` will be returned.
          * @since v15.9.0
@@ -452,7 +452,7 @@ declare module 'tls' {
          * SecureContext.) If SNICallback wasn't provided the default callback
          * with high-level API will be used (see below).
          */
-        SNICallback?: ((servername: string, cb: (err: Error | null, ctx: SecureContext) => void) => void) | undefined;
+        SNICallback?: ((servername: string, cb: (err: Error | null, ctx?: SecureContext) => void) => void) | undefined;
         /**
          * If true the server will reject any connection which is not
          * authorized with the list of supplied CAs. This option only has an

node/trace_events.d.ts

@@ -73,7 +73,7 @@
  *
  * The features from this module are not available in `Worker` threads.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/trace_events.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/trace_events.js)
  */
 declare module 'trace_events' {
     /**

node/ts3.6/base.d.ts

@@ -7,7 +7,7 @@
 //          - ~/ts3.6/index.d.ts  - Definitions specific to TypeScript 3.6 and earlier with assert pulled in
 
 // Reference required types from the default lib:
-/// <reference lib="es2018" />
+/// <reference lib="es2020" />
 /// <reference lib="esnext.asynciterable" />
 /// <reference lib="esnext.intl" />
 /// <reference lib="esnext.bigint" />
@@ -47,6 +47,7 @@
 /// <reference path="../repl.d.ts" />
 /// <reference path="../stream.d.ts" />
 /// <reference path="../stream/promises.d.ts" />
+/// <reference path="../stream/web.d.ts" />
 /// <reference path="../string_decoder.d.ts" />
 /// <reference path="../timers.d.ts" />
 /// <reference path="../timers/promises.d.ts" />

node/tty.d.ts

@@ -22,7 +22,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/v16.4.2/lib/tty.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/tty.js)
  */
 declare module 'tty' {
     import * as net from 'node:net';
@@ -176,9 +176,9 @@ declare module 'tty' {
         hasColors(env?: object): boolean;
         hasColors(count: number, env?: object): boolean;
         /**
-         * `writeStream.getWindowSize()` returns the size of the `TTY` corresponding to this `WriteStream`. The array is of the type`[numColumns, numRows]` where `numColumns` and `numRows` represent
-         * the number
-         * of columns and rows in the corresponding `TTY`.
+         * `writeStream.getWindowSize()` returns the size of the TTY
+         * corresponding to this `WriteStream`. The array is of the type`[numColumns, numRows]` where `numColumns` and `numRows` represent the number
+         * of columns and rows in the corresponding TTY.
          * @since v0.7.7
          */
         getWindowSize(): [number, number];

node/url.d.ts

@@ -5,13 +5,10 @@
  * ```js
  * import url from 'url';
  * ```
- *
- * ```js
- * const url = require('url');
- * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/url.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/url.js)
  */
 declare module 'url' {
+    import { Blob } from 'node:buffer';
     import { ClientRequestArgs } from 'node:http';
     import { ParsedUrlQuery, ParsedUrlQueryInput } from 'node:querystring';
     // Input to `url.format`
@@ -191,17 +188,6 @@ declare module 'url' {
      * console.log(url.domainToASCII('xn--iñvalid.com'));
      * // Prints an empty string
      * ```
-     *
-     * ```js
-     * const url = require('url');
-     *
-     * console.log(url.domainToASCII('español.com'));
-     * // Prints xn--espaol-zwa.com
-     * console.log(url.domainToASCII('中文.com'));
-     * // Prints xn--fiq228c.com
-     * console.log(url.domainToASCII('xn--iñvalid.com'));
-     * // Prints an empty string
-     * ```
      * @since v7.4.0, v6.13.0
      */
     function domainToASCII(domain: string): string;
@@ -223,17 +209,6 @@ declare module 'url' {
      * console.log(url.domainToUnicode('xn--iñvalid.com'));
      * // Prints an empty string
      * ```
-     *
-     * ```js
-     * const url = require('url');
-     *
-     * console.log(url.domainToUnicode('xn--espaol-zwa.com'));
-     * // Prints español.com
-     * console.log(url.domainToUnicode('xn--fiq228c.com'));
-     * // Prints 中文.com
-     * console.log(url.domainToUnicode('xn--iñvalid.com'));
-     * // Prints an empty string
-     * ```
      * @since v7.4.0, v6.13.0
      */
     function domainToUnicode(domain: string): string;
@@ -258,21 +233,6 @@ declare module 'url' {
      * new URL('file:///hello world').pathname;   // Incorrect: /hello%20world
      * fileURLToPath('file:///hello world');      // Correct:   /hello world (POSIX)
      * ```
-     *
-     * ```js
-     * const { fileURLToPath } = require('url');
-     * new URL('file:///C:/path/').pathname;      // Incorrect: /C:/path/
-     * fileURLToPath('file:///C:/path/');         // Correct:   C:\path\ (Windows)
-     *
-     * new URL('file://nas/foo.txt').pathname;    // Incorrect: /foo.txt
-     * fileURLToPath('file://nas/foo.txt');       // Correct:   \\nas\foo.txt (Windows)
-     *
-     * new URL('file:///你好.txt').pathname;      // Incorrect: /%E4%BD%A0%E5%A5%BD.txt
-     * fileURLToPath('file:///你好.txt');         // Correct:   /你好.txt (POSIX)
-     *
-     * new URL('file:///hello world').pathname;   // Incorrect: /hello%20world
-     * fileURLToPath('file:///hello world');      // Correct:   /hello world (POSIX)
-     * ```
      * @since v10.12.0
      * @param url The file URL string or URL object to convert to a path.
      * @return The fully-resolved platform-specific Node.js file path.
@@ -291,20 +251,6 @@ declare module 'url' {
      * new URL('/some/path%.c', 'file:');    // Incorrect: file:///some/path%.c
      * pathToFileURL('/some/path%.c');       // Correct:   file:///some/path%25.c (POSIX)
      * ```
-     *
-     * ```js
-     * const { pathToFileURL } = require('url');
-     * new URL(__filename);                  // Incorrect: throws (POSIX)
-     * new URL(__filename);                  // Incorrect: C:\... (Windows)
-     * pathToFileURL(__filename);            // Correct:   file:///... (POSIX)
-     * pathToFileURL(__filename);            // Correct:   file:///C:/... (Windows)
-     *
-     * new URL('/foo#1', 'file:');           // Incorrect: file:///foo#1
-     * pathToFileURL('/foo#1');              // Correct:   file:///foo%231 (POSIX)
-     *
-     * new URL('/some/path%.c', 'file:');    // Incorrect: file:///some/path%.c
-     * pathToFileURL('/some/path%.c');       // Correct:   file:///some/path%25.c (POSIX)
-     * ```
      * @since v10.12.0
      * @param path The path to convert to a File URL.
      * @return The file URL object.
@@ -318,26 +264,7 @@ declare module 'url' {
      * import { urlToHttpOptions } from 'url';
      * const myURL = new URL('https://a:b@測試?abc#foo');
      *
-     * console.log(urlToHttpOptions(myUrl));
-     *
-     * {
-     *   protocol: 'https:',
-     *   hostname: 'xn--g6w251d',
-     *   hash: '#foo',
-     *   search: '?abc',
-     *   pathname: '/',
-     *   path: '/?abc',
-     *   href: 'https://a:b@xn--g6w251d/?abc#foo',
-     *   auth: 'a:b'
-     * }
-     *
-     * ```
-     *
-     * ```js
-     * const { urlToHttpOptions } = require('url');
-     * const myURL = new URL('https://a:b@測試?abc#foo');
-     *
-     * console.log(urlToHttpOptions(myUrl));
+     * console.log(urlToHttpOptions(myURL));
      *
      * {
      *   protocol: 'https:',
@@ -375,6 +302,40 @@ declare module 'url' {
      * @since v7.0.0, v6.13.0
      */
     class URL {
+        /**
+         * Creates a `'blob:nodedata:...'` URL string that represents the given `Blob` object and can be used to retrieve the `Blob` later.
+         *
+         * ```js
+         * const {
+         *   Blob,
+         *   resolveObjectURL,
+         * } = require('buffer');
+         *
+         * const blob = new Blob(['hello']);
+         * const id = URL.createObjectURL(blob);
+         *
+         * // later...
+         *
+         * const otherBlob = resolveObjectURL(id);
+         * console.log(otherBlob.size);
+         * ```
+         *
+         * The data stored by the registered `Blob` will be retained in memory until`URL.revokeObjectURL()` is called to remove it.
+         *
+         * `Blob` objects are registered within the current thread. If using Worker
+         * Threads, `Blob` objects registered within one Worker will not be available
+         * to other workers or the main thread.
+         * @since v16.7.0
+         * @experimental
+         */
+        static createObjectURL(blob: Blob): string;
+        /**
+         * Removes the stored `Blob` identified by the given ID.
+         * @since v16.7.0
+         * @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);
         /**
          * Gets and sets the fragment portion of the URL.

node/util.d.ts

@@ -6,7 +6,7 @@
  * ```js
  * const util = require('util');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/util.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/util.js)
  */
 declare module 'util' {
     import * as types from 'node:util/types';
@@ -1538,12 +1538,12 @@ declare module 'util/types' {
      */
     function isWeakSet(object: unknown): object is WeakSet<object>;
     /**
-     * Returns `true` if `value` is a `<KeyObject>`, `false` otherwise.
+     * Returns `true` if `value` is a `KeyObject`, `false` otherwise.
      * @since v16.2.0
      */
     function isKeyObject(object: unknown): object is KeyObject;
     /**
-     * Returns `true` if `value` is a `<CryptoKey>`, `false` otherwise.
+     * Returns `true` if `value` is a `CryptoKey`, `false` otherwise.
      * @since v16.2.0
      */
     function isCryptoKey(object: unknown): object is webcrypto.CryptoKey;

node/v8.d.ts

@@ -4,7 +4,7 @@
  * ```js
  * const v8 = require('v8');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/v8.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/v8.js)
  */
 declare module 'v8' {
     import { Readable } from 'node:stream';

node/vm.d.ts

@@ -1,7 +1,7 @@
 /**
  * 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**.
+ * **not use it to run untrusted code.**
  *
  * JavaScript code can be compiled and run immediately or
  * compiled, saved, and run later.
@@ -32,7 +32,7 @@
  *
  * console.log(x); // 1; y is not defined.
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/vm.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/vm.js)
  */
 declare module 'vm' {
     interface Context extends NodeJS.Dict<any> {}

node/wasi.d.ts

@@ -5,10 +5,11 @@
  * ```js
  * import fs from 'fs';
  * import { WASI } from 'wasi';
+ * import { argv, env } from 'process';
  *
  * const wasi = new WASI({
- *   args: process.argv,
- *   env: process.env,
+ *   args: argv,
+ *   env,
  *   preopens: {
  *     '/sandbox': '/some/real/path/that/wasm/can/access'
  *   }
@@ -21,27 +22,6 @@
  * wasi.start(instance);
  * ```
  *
- * ```js
- * 'use strict';
- * const fs = require('fs');
- * const { WASI } = require('wasi');
- * const wasi = new WASI({
- *   args: process.argv,
- *   env: process.env,
- *   preopens: {
- *     '/sandbox': '/some/real/path/that/wasm/can/access'
- *   }
- * });
- * const importObject = { wasi_snapshot_preview1: wasi.wasiImport };
- *
- * (async () => {
- *   const wasm = await WebAssembly.compile(fs.readFileSync('./demo.wasm'));
- *   const instance = await WebAssembly.instantiate(wasm, importObject);
- *
- *   wasi.start(instance);
- * })();
- * ```
- *
  * To run the above example, create a new WebAssembly text format file named`demo.wat`:
  *
  * ```text
@@ -83,7 +63,7 @@
  * The `--experimental-wasi-unstable-preview1` CLI argument is needed for this
  * example to run.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/wasi.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/wasi.js)
  */
 declare module 'wasi' {
     interface WASIOptions {

node/worker_threads.d.ts

@@ -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/v16.4.2/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v16.7.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';

node/zlib.d.ts

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