@types/node 18.19.51 → 18.19.53

node v18.19/stream.d.ts

@@ -9,7 +9,7 @@
  * To access the `stream` module:
  *
  * ```js
- * const stream = require('stream');
+ * import stream from 'node:stream';
  * ```
  *
  * The `stream` module is useful for creating new types of stream instances. It is
@@ -326,7 +326,7 @@ declare module "stream" {
              * the method does nothing.
              *
              * ```js
-             * const fs = require('fs');
+             * import fs from 'node:fs';
              * const readable = getReadableStreamSomehow();
              * const writable = fs.createWriteStream('file.txt');
              * // All the data from readable goes into 'file.txt',
@@ -364,7 +364,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('string_decoder');
+             * import { StringDecoder } from 'node:string_decoder';
              * function parseHeader(stream, callback) {
              *   stream.on('error', callback);
              *   stream.on('readable', onReadable);
@@ -422,8 +422,8 @@ declare module "stream" {
              * libraries.
              *
              * ```js
-             * const { OldReader } = require('./old-api-module.js');
-             * const { Readable } = require('stream');
+             * import { OldReader } from './old-api-module.js';
+             * import { Readable } from 'node:stream';
              * const oreader = new OldReader();
              * const myReader = new Readable().wrap(oreader);
              *
@@ -865,7 +865,7 @@ declare module "stream" {
              *
              * ```js
              * // Write 'hello, ' and then end with 'world!'.
-             * const fs = require('fs');
+             * import fs from 'node:fs';
              * const file = fs.createWriteStream('example.txt');
              * file.write('hello, ');
              * file.end('world!');
@@ -1261,7 +1261,7 @@ declare module "stream" {
          * Calling `abort` on the `AbortController` corresponding to the passed`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`on the stream.
          *
          * ```js
-         * const fs = require('fs');
+         * import fs from 'node:fs';
          *
          * const controller = new AbortController();
          * const read = addAbortSignal(
@@ -1324,7 +1324,7 @@ declare module "stream" {
          * or has experienced an error or a premature close event.
          *
          * ```js
-         * const { finished } = require('stream');
+         * import { finished } from 'node:stream';
          *
          * const rs = fs.createReadStream('archive.tar');
          *
@@ -1345,7 +1345,7 @@ declare module "stream" {
          * The `finished` API provides promise version:
          *
          * ```js
-         * const { finished } = require('stream/promises');
+         * import { finished } from 'node:stream/promises';
          *
          * const rs = fs.createReadStream('archive.tar');
          *
@@ -1421,9 +1421,9 @@ declare module "stream" {
          * properly cleaning up and provide a callback when the pipeline is complete.
          *
          * ```js
-         * const { pipeline } = require('stream');
-         * const fs = require('fs');
-         * const zlib = require('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.
@@ -1449,7 +1449,7 @@ declare module "stream" {
          * an`AbortError`.
          *
          * ```js
-         * const { pipeline } = require('stream/promises');
+         * import { pipeline } from 'node:stream/promises';
          *
          * async function run() {
          *   await pipeline(
@@ -1467,7 +1467,7 @@ declare module "stream" {
          * as the last argument:
          *
          * ```js
-         * const { pipeline } = require('stream/promises');
+         * import { pipeline } from 'node:stream/promises';
          *
          * async function run() {
          *   const ac = new AbortController();
@@ -1488,8 +1488,8 @@ declare module "stream" {
          * The `pipeline` API also supports async generators:
          *
          * ```js
-         * const { pipeline } = require('stream/promises');
-         * const fs = require('fs');
+         * import { pipeline } from 'node:stream/promises';
+         * import fs from 'node:fs';
          *
          * async function run() {
          *   await pipeline(
@@ -1513,8 +1513,8 @@ declare module "stream" {
          * pipeline (i.e. first argument) or the pipeline will never complete.
          *
          * ```js
-         * const { pipeline } = require('stream/promises');
-         * const fs = require('fs');
+         * import { pipeline } from 'node:stream/promises';
+         * import fs from 'node:fs';
          *
          * async function run() {
          *   await pipeline(
@@ -1547,9 +1547,9 @@ declare module "stream" {
          * See the example below:
          *
          * ```js
-         * const fs = require('fs');
-         * const http = require('http');
-         * const { pipeline } = require('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 v18.19/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 v18.19/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('timers/promises')`.
+ * that return `Promise` objects. The API is accessible via `import timersPromises from 'node:timers/promises'`.
  *
  * ```js
  * import {

node v18.19/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('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 v18.19/tls.d.ts

@@ -4,7 +4,7 @@
  * The module can be accessed using:
  *
  * ```js
- * const tls = require('tls');
+ * import tls from 'node:tls';
  * ```
  * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/tls.js)
  */
@@ -1000,8 +1000,8 @@ declare module "tls" {
      * The following illustrates a simple echo server:
      *
      * ```js
-     * const tls = require('tls');
-     * const fs = require('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('tls');
-     * const fs = require('fs');
+     * import tls from 'node:tls';
+     * import fs from 'node:fs';
      *
      * const options = {
      *   // Necessary only if the server requires client certificate authentication.

node v18.19/trace_events.d.ts

@@ -46,7 +46,7 @@
  * Alternatively, trace events may be enabled using the `trace_events` module:
  *
  * ```js
- * const trace_events = require('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
  *
@@ -132,7 +132,7 @@ declare module "trace_events" {
      * Creates and returns a `Tracing` object for the given set of `categories`.
      *
      * ```js
-     * const trace_events = require('trace_events');
+     * import trace_events from 'node:trace_events';
      * const categories = ['node.perf', 'node.async_hooks'];
      * const tracing = trace_events.createTracing({ categories });
      * tracing.enable();
@@ -152,7 +152,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('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 v18.19/tty.d.ts

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

node v18.19/url.d.ts

@@ -83,7 +83,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',
@@ -147,7 +147,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',
@@ -212,7 +212,7 @@ declare module "url" {
      * manner similar to that of a web browser resolving an anchor tag.
      *
      * ```js
-     * const url = require('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'
@@ -394,10 +394,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('buffer');
+         * } from 'node:buffer';
          *
          * const blob = new Blob(['hello']);
          * const id = URL.createObjectURL(blob);
@@ -928,7 +928,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
          */
@@ -938,7 +938,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 v18.19/util.d.ts

@@ -4,7 +4,7 @@
  * it:
  *
  * ```js
- * const util = require('util');
+ * import util from 'node:util';
  * ```
  * @see [source](https://github.com/nodejs/node/blob/v18.x/lib/util.js)
  */
@@ -200,7 +200,7 @@ declare module "util" {
      * timestamp.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.log('Timestamped message.');
      * ```
@@ -268,7 +268,7 @@ declare module "util" {
      * Circular references point to their anchor by using a reference index:
      *
      * ```js
-     * const { inspect } = require('util');
+     * import { inspect } from 'node:util';
      *
      * const obj = {};
      * obj.a = [obj];
@@ -286,7 +286,7 @@ declare module "util" {
      * The following example inspects all properties of the `util` object:
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * console.log(util.inspect(util, { showHidden: true, depth: null }));
      * ```
@@ -294,7 +294,7 @@ declare module "util" {
      * The following example highlights the effect of the `compact` option:
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * const o = {
      *   a: [1, 2, [[
@@ -351,7 +351,7 @@ declare module "util" {
      * with no remaining strong references may be garbage collected at any time.
      *
      * ```js
-     * const { inspect } = require('util');
+     * import { inspect } from 'node:util';
      *
      * const obj = { a: 1 };
      * const obj2 = { b: 2 };
@@ -365,8 +365,8 @@ declare module "util" {
      * impact the result of `util.inspect()`.
      *
      * ```js
-     * const { inspect } = require('util');
-     * const assert = require('assert');
+     * import { inspect } from 'node:util';
+     * import assert from 'node:assert';
      *
      * const o1 = {
      *   b: [2, 3, 1],
@@ -393,7 +393,7 @@ declare module "util" {
      * numbers.
      *
      * ```js
-     * const { inspect } = require('util');
+     * import { inspect } from 'node:util';
      *
      * const thousand = 1_000;
      * const million = 1_000_000;
@@ -434,7 +434,7 @@ declare module "util" {
      * Returns `true` if the given `object` is an `Array`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isArray([]);
      * // Returns: true
@@ -451,7 +451,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `RegExp`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isRegExp(/some regexp/);
      * // Returns: true
@@ -468,7 +468,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Date`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isDate(new Date());
      * // Returns: true
@@ -485,7 +485,7 @@ declare module "util" {
      * Returns `true` if the given `object` is an `Error`. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isError(new Error());
      * // Returns: true
@@ -499,7 +499,7 @@ declare module "util" {
      * possible to obtain an incorrect result when the `object` argument manipulates`@@toStringTag`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      * const obj = { name: 'Error', message: 'an error occurred' };
      *
      * util.isError(obj);
@@ -524,8 +524,8 @@ declare module "util" {
      * through the `constructor.super_` property.
      *
      * ```js
-     * const util = require('util');
-     * const EventEmitter = require('events');
+     * import util from 'node:util';
+     * import EventEmitter from 'node:events';
      *
      * function MyStream() {
      *   EventEmitter.call(this);
@@ -551,7 +551,7 @@ declare module "util" {
      * ES6 example using `class` and `extends`:
      *
      * ```js
-     * const EventEmitter = require('events');
+     * import EventEmitter from 'node:events';
      *
      * class MyStream extends EventEmitter {
      *   write(data) {
@@ -580,7 +580,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('util');
+     * import util from 'node:util';
      * const debuglog = util.debuglog('foo');
      *
      * debuglog('hello from foo [%d]', 123);
@@ -599,7 +599,7 @@ declare module "util" {
      * The `section` supports wildcard also:
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      * const debuglog = util.debuglog('foo-bar');
      *
      * debuglog('hi there, it\'s foo-bar [%d]', 2333);
@@ -619,7 +619,7 @@ declare module "util" {
      * unnecessary wrapping.
      *
      * ```js
-     * const util = require('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
@@ -637,7 +637,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Boolean`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isBoolean(1);
      * // Returns: false
@@ -654,7 +654,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Buffer`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isBuffer({ length: 0 });
      * // Returns: false
@@ -671,7 +671,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Function`. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * function Foo() {}
      * const Bar = () => {};
@@ -691,7 +691,7 @@ declare module "util" {
      * Returns `true` if the given `object` is strictly `null`. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isNull(0);
      * // Returns: false
@@ -709,7 +709,7 @@ declare module "util" {
      * returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isNullOrUndefined(0);
      * // Returns: false
@@ -726,7 +726,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Number`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isNumber(false);
      * // Returns: false
@@ -746,7 +746,7 @@ declare module "util" {
      * Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isObject(5);
      * // Returns: false
@@ -765,7 +765,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a primitive type. Otherwise, returns`false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isPrimitive(5);
      * // Returns: true
@@ -794,7 +794,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `string`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isString('');
      * // Returns: true
@@ -813,7 +813,7 @@ declare module "util" {
      * Returns `true` if the given `object` is a `Symbol`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * util.isSymbol(5);
      * // Returns: false
@@ -830,7 +830,7 @@ declare module "util" {
      * Returns `true` if the given `object` is `undefined`. Otherwise, returns `false`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * const foo = undefined;
      * util.isUndefined(5);
@@ -849,7 +849,7 @@ declare module "util" {
      * such a way that it is marked as deprecated.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * exports.obsoleteFunction = util.deprecate(() => {
      *   // Do something here.
@@ -865,7 +865,7 @@ declare module "util" {
      * the warning will be emitted only once for that `code`.
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * const fn1 = util.deprecate(someFunction, someMessage, 'DEP0001');
      * const fn2 = util.deprecate(someOtherFunction, someOtherMessage, 'DEP0001');
@@ -919,7 +919,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('util');
+     * import util from 'node:util';
      *
      * async function fn() {
      *   return 'hello world';
@@ -1045,8 +1045,8 @@ declare module "util" {
      * that returns promises.
      *
      * ```js
-     * const util = require('util');
-     * const fs = require('fs');
+     * import util from 'node:util';
+     * import fs from 'node:fs';
      *
      * const stat = util.promisify(fs.stat);
      * stat('.').then((stats) => {
@@ -1059,8 +1059,8 @@ declare module "util" {
      * Or, equivalently using `async function`s:
      *
      * ```js
-     * const util = require('util');
-     * const fs = require('fs');
+     * import util from 'node:util';
+     * import fs from 'node:fs';
      *
      * const stat = util.promisify(fs.stat);
      *
@@ -1081,7 +1081,7 @@ declare module "util" {
      * work as expected unless handled specially:
      *
      * ```js
-     * const util = require('util');
+     * import util from 'node:util';
      *
      * class Foo {
      *   constructor() {
@@ -1248,7 +1248,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
          */
@@ -1259,7 +1259,7 @@ declare module "util" {
             : 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
          */