@types/node 20.16.7 → 20.16.9

node v20.16/stream.d.ts

@@ -10,7 +10,7 @@
  * To access the `node:stream` module:
  *
  * ```js
- * const stream = require('node:stream');
+ * import stream from 'node:stream';
  * ```
  *
  * The `node:stream` module is useful for creating new types of stream instances.
@@ -303,7 +303,7 @@ declare module "stream" {
          * the method does nothing.
          *
          * ```js
-         * const fs = require('node:fs');
+         * import fs from 'node:fs';
          * const readable = getReadableStreamSomehow();
          * const writable = fs.createWriteStream('file.txt');
          * // All the data from readable goes into 'file.txt',
@@ -341,7 +341,7 @@ declare module "stream" {
          * // Pull off a header delimited by \n\n.
          * // Use unshift() if we get too much.
          * // Call the callback with (error, header, stream).
-         * const { StringDecoder } = require('node:string_decoder');
+         * import { StringDecoder } from 'node:string_decoder';
          * function parseHeader(stream, callback) {
          *   stream.on('error', callback);
          *   stream.on('readable', onReadable);
@@ -399,8 +399,8 @@ declare module "stream" {
          * libraries.
          *
          * ```js
-         * const { OldReader } = require('./old-api-module.js');
-         * const { Readable } = require('node:stream');
+         * import { OldReader } from './old-api-module.js';
+         * import { Readable } from 'node:stream';
          * const oreader = new OldReader();
          * const myReader = new Readable().wrap(oreader);
          *
@@ -806,7 +806,7 @@ declare module "stream" {
          *
          * ```js
          * // Write 'hello, ' and then end with 'world!'.
-         * const fs = require('node:fs');
+         * import fs from 'node:fs';
          * const file = fs.createWriteStream('example.txt');
          * file.write('hello, ');
          * file.end('world!');
@@ -1304,7 +1304,7 @@ declare module "stream" {
          * stream, and `controller.error(new AbortError())` for webstreams.
          *
          * ```js
-         * const fs = require('node:fs');
+         * import fs from 'node:fs';
          *
          * const controller = new AbortController();
          * const read = addAbortSignal(
@@ -1398,8 +1398,8 @@ declare module "stream" {
          * or has experienced an error or a premature close event.
          *
          * ```js
-         * const { finished } = require('node:stream');
-         * const fs = require('node:fs');
+         * import { finished } from 'node:stream';
+         * import fs from 'node:fs';
          *
          * const rs = fs.createReadStream('archive.tar');
          *
@@ -1482,9 +1482,9 @@ declare module "stream" {
          * properly cleaning up and provide a callback when the pipeline is complete.
          *
          * ```js
-         * const { pipeline } = require('node:stream');
-         * const fs = require('node:fs');
-         * const zlib = require('node:zlib');
+         * import { pipeline } from 'node:stream';
+         * import fs from 'node:fs';
+         * import zlib from 'node:zlib';
          *
          * // Use the pipeline API to easily pipe a series of streams
          * // together and get notified when the pipeline is fully done.
@@ -1524,9 +1524,9 @@ declare module "stream" {
          * See the example below:
          *
          * ```js
-         * const fs = require('node:fs');
-         * const http = require('node:http');
-         * const { pipeline } = require('node:stream');
+         * import fs from 'node:fs';
+         * import http from 'node:http';
+         * import { pipeline } from 'node:stream';
          *
          * const server = http.createServer((req, res) => {
          *   const fileStream = fs.createReadStream('./fileNotExist.txt');

node v20.16/string_decoder.d.ts

@@ -4,13 +4,13 @@
  * characters. It can be accessed using:
  *
  * ```js
- * const { StringDecoder } = require('node:string_decoder');
+ * import { StringDecoder } from 'node:string_decoder';
  * ```
  *
  * The following example shows the basic use of the `StringDecoder` class.
  *
  * ```js
- * const { StringDecoder } = require('node:string_decoder');
+ * import { StringDecoder } from 'node:string_decoder';
  * const decoder = new StringDecoder('utf8');
  *
  * const cent = Buffer.from([0xC2, 0xA2]);
@@ -29,7 +29,7 @@
  * symbol (`€`) are written over three separate operations:
  *
  * ```js
- * const { StringDecoder } = require('node:string_decoder');
+ * import { StringDecoder } from 'node:string_decoder';
  * const decoder = new StringDecoder('utf8');
  *
  * decoder.write(Buffer.from([0xE2]));

node v20.16/timers/promises.d.ts

@@ -1,6 +1,6 @@
 /**
  * The `timers/promises` API provides an alternative set of timer functions
- * that return `Promise` objects. The API is accessible via `require('node:timers/promises')`.
+ * that return `Promise` objects. The API is accessible via `import timersPromises from 'node:timers/promises'`.
  *
  * ```js
  * import {

node v20.16/timers.d.ts

@@ -1,7 +1,7 @@
 /**
  * The `timer` module exposes a global API for scheduling functions to
  * be called at some future period of time. Because the timer functions are
- * globals, there is no need to call `require('node:timers')` to use the API.
+ * globals, there is no need to import `node:timers` to use the API.
  *
  * 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

node v20.16/tls.d.ts

@@ -4,7 +4,7 @@
  * The module can be accessed using:
  *
  * ```js
- * const tls = require('node:tls');
+ * import tls from 'node:tls';
  * ```
  * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/tls.js)
  */
@@ -1000,8 +1000,8 @@ declare module "tls" {
      * The following illustrates a simple echo server:
      *
      * ```js
-     * const tls = require('node:tls');
-     * const fs = require('node:fs');
+     * import tls from 'node:tls';
+     * import fs from 'node:fs';
      *
      * const options = {
      *   key: fs.readFileSync('server-key.pem'),
@@ -1046,8 +1046,8 @@ declare module "tls" {
      *
      * ```js
      * // Assumes an echo server that is listening on port 8000.
-     * const tls = require('node:tls');
-     * const fs = require('node:fs');
+     * import tls from 'node:tls';
+     * import fs from 'node:fs';
      *
      * const options = {
      *   // Necessary only if the server requires client certificate authentication.

node v20.16/trace_events.d.ts

@@ -53,7 +53,7 @@
  * Alternatively, trace events may be enabled using the `node:trace_events` module:
  *
  * ```js
- * const trace_events = require('node:trace_events');
+ * import trace_events from 'node:trace_events';
  * const tracing = trace_events.createTracing({ categories: ['node.perf'] });
  * tracing.enable();  // Enable trace event capture for the 'node.perf' category
  *
@@ -118,7 +118,7 @@ declare module "trace_events" {
          * will be disabled.
          *
          * ```js
-         * const trace_events = require('node:trace_events');
+         * import trace_events from 'node:trace_events';
          * const t1 = trace_events.createTracing({ categories: ['node', 'v8'] });
          * const t2 = trace_events.createTracing({ categories: ['node.perf', 'node'] });
          * t1.enable();
@@ -159,7 +159,7 @@ declare module "trace_events" {
      * Creates and returns a `Tracing` object for the given set of `categories`.
      *
      * ```js
-     * const trace_events = require('node:trace_events');
+     * import trace_events from 'node:trace_events';
      * const categories = ['node.perf', 'node.async_hooks'];
      * const tracing = trace_events.createTracing({ categories });
      * tracing.enable();
@@ -178,7 +178,7 @@ declare module "trace_events" {
      * Given the file `test.js` below, the command `node --trace-event-categories node.perf test.js` will print `'node.async_hooks,node.perf'` to the console.
      *
      * ```js
-     * const trace_events = require('node:trace_events');
+     * import trace_events from 'node:trace_events';
      * const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] });
      * const t2 = trace_events.createTracing({ categories: ['node.perf'] });
      * const t3 = trace_events.createTracing({ categories: ['v8'] });

node v20.16/tty.d.ts

@@ -3,7 +3,7 @@
  * directly. However, it can be accessed using:
  *
  * ```js
- * const tty = require('node:tty');
+ * import tty from 'node:tty';
  * ```
  *
  * When Node.js detects that it is being run with a text terminal ("TTY")

node v20.16/url.d.ts

@@ -85,7 +85,7 @@ declare module "url" {
      * The `url.format()` method returns a formatted URL string derived from `urlObject`.
      *
      * ```js
-     * const url = require('node:url');
+     * import url from 'node:url';
      * url.format({
      *   protocol: 'https',
      *   hostname: 'example.com',
@@ -149,7 +149,7 @@ declare module "url" {
      * The `url.format()` method returns a formatted URL string derived from `urlObject`.
      *
      * ```js
-     * const url = require('node:url');
+     * import url from 'node:url';
      * url.format({
      *   protocol: 'https',
      *   hostname: 'example.com',
@@ -214,7 +214,7 @@ declare module "url" {
      * manner similar to that of a web browser resolving an anchor tag.
      *
      * ```js
-     * const url = require('node:url');
+     * import url from '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'
@@ -392,10 +392,10 @@ declare module "url" {
          * Creates a `'blob:nodedata:...'` URL string that represents the given `Blob` object and can be used to retrieve the `Blob` later.
          *
          * ```js
-         * const {
+         * import {
          *   Blob,
          *   resolveObjectURL,
-         * } = require('node:buffer');
+         * } from 'node:buffer';
          *
          * const blob = new Blob(['hello']);
          * const id = URL.createObjectURL(blob);
@@ -926,7 +926,7 @@ declare module "url" {
             URLSearchParams: typeof _URLSearchParams;
         }
         /**
-         * `URL` class is a global reference for `require('url').URL`
+         * `URL` class is a global reference for `import { URL } from 'node:url'`
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
@@ -936,7 +936,7 @@ declare module "url" {
         } ? T
             : typeof _URL;
         /**
-         * `URLSearchParams` class is a global reference for `require('url').URLSearchParams`
+         * `URLSearchParams` class is a global reference for `import { URLSearchParams } from 'node:url'`
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */

node v20.16/util.d.ts

@@ -4,7 +4,7 @@
  * it:
  *
  * ```js
- * const util = require('node:util');
+ * import util from 'node:util';
  * ```
  * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/util.js)
  */
@@ -200,7 +200,7 @@ declare module "util" {
      * timestamp.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.log('Timestamped message.');
      * ```
@@ -287,7 +287,7 @@ declare module "util" {
      * Circular references point to their anchor by using a reference index:
      *
      * ```js
-     * const { inspect } = require('node:util');
+     * import { inspect } from 'node:util';
      *
      * const obj = {};
      * obj.a = [obj];
@@ -305,7 +305,7 @@ declare module "util" {
      * The following example inspects all properties of the `util` object:
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * console.log(util.inspect(util, { showHidden: true, depth: null }));
      * ```
@@ -313,7 +313,7 @@ declare module "util" {
      * The following example highlights the effect of the `compact` option:
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * const o = {
      *   a: [1, 2, [[
@@ -370,7 +370,7 @@ declare module "util" {
      * with no remaining strong references may be garbage collected at any time.
      *
      * ```js
-     * const { inspect } = require('node:util');
+     * import { inspect } from 'node:util';
      *
      * const obj = { a: 1 };
      * const obj2 = { b: 2 };
@@ -384,8 +384,8 @@ declare module "util" {
      * impact the result of `util.inspect()`.
      *
      * ```js
-     * const { inspect } = require('node:util');
-     * const assert = require('node:assert');
+     * import { inspect } from 'node:util';
+     * import assert from 'node:assert';
      *
      * const o1 = {
      *   b: [2, 3, 1],
@@ -412,7 +412,7 @@ declare module "util" {
      * numbers.
      *
      * ```js
-     * const { inspect } = require('node:util');
+     * import { inspect } from 'node:util';
      *
      * const thousand = 1_000;
      * const million = 1_000_000;
@@ -459,7 +459,7 @@ declare module "util" {
      * Returns `true` if the given `object` is an `Array`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isArray([]);
      * // Returns: true
@@ -476,7 +476,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `RegExp`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isRegExp(/some regexp/);
      * // Returns: true
@@ -493,7 +493,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Date`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isDate(new Date());
      * // Returns: true
@@ -510,7 +510,7 @@ declare module "util" {
      * Returns `true` if the given `object` is an `Error`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isError(new Error());
      * // Returns: true
@@ -524,7 +524,7 @@ declare module "util" {
      * possible to obtain an incorrect result when the `object` argument manipulates `@@toStringTag`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      * const obj = { name: 'Error', message: 'an error occurred' };
      *
      * util.isError(obj);
@@ -549,8 +549,8 @@ declare module "util" {
      * through the `constructor.super_` property.
      *
      * ```js
-     * const util = require('node:util');
-     * const EventEmitter = require('node:events');
+     * import util from 'node:util';
+     * import EventEmitter from 'node:events';
      *
      * function MyStream() {
      *   EventEmitter.call(this);
@@ -576,7 +576,7 @@ declare module "util" {
      * ES6 example using `class` and `extends`:
      *
      * ```js
-     * const EventEmitter = require('node:events');
+     * import EventEmitter from 'node:events';
      *
      * class MyStream extends EventEmitter {
      *   write(data) {
@@ -605,7 +605,7 @@ declare module "util" {
      * environment variable, then the returned function operates similar to `console.error()`. If not, then the returned function is a no-op.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      * const debuglog = util.debuglog('foo');
      *
      * debuglog('hello from foo [%d]', 123);
@@ -624,7 +624,7 @@ declare module "util" {
      * The `section` supports wildcard also:
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      * const debuglog = util.debuglog('foo-bar');
      *
      * debuglog('hi there, it\'s foo-bar [%d]', 2333);
@@ -644,7 +644,7 @@ declare module "util" {
      * unnecessary wrapping.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      * let debuglog = util.debuglog('internals', (debug) => {
      *   // Replace with a logging function that optimizes out
      *   // testing if the section is enabled
@@ -662,7 +662,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Boolean`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isBoolean(1);
      * // Returns: false
@@ -679,7 +679,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Buffer`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isBuffer({ length: 0 });
      * // Returns: false
@@ -696,7 +696,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Function`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * function Foo() {}
      * const Bar = () => {};
@@ -716,7 +716,7 @@ declare module "util" {
      * Returns `true` if the given `object` is strictly `null`. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isNull(0);
      * // Returns: false
@@ -734,7 +734,7 @@ declare module "util" {
      * returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isNullOrUndefined(0);
      * // Returns: false
@@ -751,7 +751,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Number`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isNumber(false);
      * // Returns: false
@@ -771,7 +771,7 @@ declare module "util" {
      * Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isObject(5);
      * // Returns: false
@@ -790,7 +790,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a primitive type. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isPrimitive(5);
      * // Returns: true
@@ -819,7 +819,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `string`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isString('');
      * // Returns: true
@@ -838,7 +838,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Symbol`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * util.isSymbol(5);
      * // Returns: false
@@ -855,7 +855,7 @@ declare module "util" {
      * Returns `true` if the given `object` is `undefined`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * const foo = undefined;
      * util.isUndefined(5);
@@ -874,7 +874,7 @@ declare module "util" {
      * such a way that it is marked as deprecated.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * exports.obsoleteFunction = util.deprecate(() => {
      *   // Do something here.
@@ -890,7 +890,7 @@ declare module "util" {
      * the warning will be emitted only once for that `code`.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * const fn1 = util.deprecate(someFunction, someMessage, 'DEP0001');
      * const fn2 = util.deprecate(someOtherFunction, someOtherMessage, 'DEP0001');
@@ -944,7 +944,7 @@ declare module "util" {
      * first argument will be the rejection reason (or `null` if the `Promise` resolved), and the second argument will be the resolved value.
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * async function fn() {
      *   return 'hello world';
@@ -1070,8 +1070,8 @@ declare module "util" {
      * that returns promises.
      *
      * ```js
-     * const util = require('node:util');
-     * const fs = require('node:fs');
+     * import util from 'node:util';
+     * import fs from 'node:fs';
      *
      * const stat = util.promisify(fs.stat);
      * stat('.').then((stats) => {
@@ -1084,8 +1084,8 @@ declare module "util" {
      * Or, equivalently using `async function`s:
      *
      * ```js
-     * const util = require('node:util');
-     * const fs = require('node:fs');
+     * import util from 'node:util';
+     * import fs from 'node:fs';
      *
      * const stat = util.promisify(fs.stat);
      *
@@ -1108,7 +1108,7 @@ declare module "util" {
      * work as expected unless handled specially:
      *
      * ```js
-     * const util = require('node:util');
+     * import util from 'node:util';
      *
      * class Foo {
      *   constructor() {
@@ -1178,7 +1178,7 @@ declare module "util" {
      * Given an example `.env` file:
      *
      * ```js
-     * const { parseEnv } = require('node:util');
+     * import { parseEnv } from 'node:util';
      *
      * parseEnv('HELLO=world\nHELLO=oh my\n');
      * // Returns: { HELLO: 'oh my' }
@@ -1247,7 +1247,7 @@ declare module "util" {
      * This function returns a formatted text considering the `format` passed.
      *
      * ```js
-     * const { styleText } = require('node:util');
+     * import { styleText } from 'node:util';
      * const errorMessage = styleText('red', 'Error! Error!');
      * console.log(errorMessage);
      * ```
@@ -1383,7 +1383,7 @@ declare module "util" {
     import { TextDecoder as _TextDecoder, TextEncoder as _TextEncoder } from "util";
     global {
         /**
-         * `TextDecoder` class is a global reference for `require('util').TextDecoder`
+         * `TextDecoder` class is a global reference for `import { TextDecoder } from 'node:util'`
          * https://nodejs.org/api/globals.html#textdecoder
          * @since v11.0.0
          */
@@ -1393,7 +1393,7 @@ declare module "util" {
         } ? TextDecoder
             : typeof _TextDecoder;
         /**
-         * `TextEncoder` class is a global reference for `require('util').TextEncoder`
+         * `TextEncoder` class is a global reference for `import { TextEncoder } from 'node:util'`
          * https://nodejs.org/api/globals.html#textencoder
          * @since v11.0.0
          */
@@ -1934,7 +1934,7 @@ declare module "util/types" {
      * ```
      *
      * ```js
-     * const native = require('napi_addon.node');
+     * const native =require('napi_addon.node');
      * const data = native.myNapi();
      * util.types.isExternal(data); // returns true
      * util.types.isExternal(0); // returns false
@@ -2084,7 +2084,7 @@ declare module "util/types" {
      * which come from a different [realm](https://tc39.es/ecma262/#realm) while `instanceof Error` returns `false` for these errors:
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      * const context = vm.createContext({});
      * const myError = vm.runInContext('new Error()', context);
      * console.log(util.types.isNativeError(myError)); // true