@types/node 20.16.7 → 20.16.9

node v20.16/v8.d.ts

@@ -2,7 +2,7 @@
  * The `node:v8` module exposes APIs that are specific to the version of [V8](https://developers.google.com/v8/) built into the Node.js binary. It can be accessed using:
  *
  * ```js
- * const v8 = require('node:v8');
+ * import v8 from 'node:v8';
  * ```
  * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/v8.js)
  */
@@ -176,7 +176,7 @@ declare module "v8" {
      *
      * ```js
      * // Print GC events to stdout for one minute.
-     * const v8 = require('node:v8');
+     * import v8 from 'node:v8';
      * v8.setFlagsFromString('--trace_gc');
      * setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
      * ```
@@ -243,7 +243,7 @@ declare module "v8" {
      *
      * ```js
      * // Print heap snapshot to the console
-     * const v8 = require('node:v8');
+     * import v8 from 'node:v8';
      * const stream = v8.getHeapSnapshot();
      * stream.pipe(process.stdout);
      * ```
@@ -268,12 +268,12 @@ declare module "v8" {
      * for a duration depending on the heap size.
      *
      * ```js
-     * const { writeHeapSnapshot } = require('node:v8');
-     * const {
+     * import { writeHeapSnapshot } from 'node:v8';
+     * import {
      *   Worker,
      *   isMainThread,
      *   parentPort,
-     * } = require('node:worker_threads');
+     * } from 'node:worker_threads';
      *
      * if (isMainThread) {
      *   const worker = new Worker(__filename);
@@ -550,7 +550,7 @@ declare module "v8" {
          * Here's an example.
          *
          * ```js
-         * const { GCProfiler } = require('v8');
+         * import { GCProfiler } from 'node:v8';
          * const profiler = new GCProfiler();
          * profiler.start();
          * setTimeout(() => {
@@ -736,12 +736,12 @@ declare module "v8" {
      * ```js
      * 'use strict';
      *
-     * const fs = require('node:fs');
-     * const zlib = require('node:zlib');
-     * const path = require('node:path');
-     * const assert = require('node:assert');
+     * import fs from 'node:fs';
+     * import zlib from 'node:zlib';
+     * import path from 'node:path';
+     * import assert from 'node:assert';
      *
-     * const v8 = require('node:v8');
+     * import v8 from 'node:v8';
      *
      * class BookShelf {
      *   storage = new Map();

node v20.16/vm.d.ts

@@ -17,7 +17,7 @@
  * code are reflected in the context object.
  *
  * ```js
- * const vm = require('node:vm');
+ * import vm from 'node:vm';
  *
  * const x = 1;
  *
@@ -203,7 +203,7 @@ declare module "vm" {
          * The globals are contained in the `context` object.
          *
          * ```js
-         * const vm = require('node:vm');
+         * import vm from 'node:vm';
          *
          * const context = {
          *   animal: 'cat',
@@ -239,7 +239,7 @@ declare module "vm" {
          * contained within each individual `context`.
          *
          * ```js
-         * const vm = require('node:vm');
+         * import vm from 'node:vm';
          *
          * const script = new vm.Script('globalVar = "set"');
          *
@@ -264,7 +264,7 @@ declare module "vm" {
          * executes that code multiple times:
          *
          * ```js
-         * const vm = require('node:vm');
+         * import vm from 'node:vm';
          *
          * global.globalVar = 0;
          *
@@ -357,7 +357,7 @@ declare module "vm" {
      * variables will remain unchanged.
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      *
      * global.globalVar = 3;
      *
@@ -404,7 +404,7 @@ declare module "vm" {
      * The following example compiles and executes different scripts using a single `contextified` object:
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      *
      * const contextObject = { globalVar: 1 };
      * vm.createContext(contextObject);
@@ -433,7 +433,7 @@ declare module "vm" {
      * variable and sets a new one. These globals are contained in the `contextObject`.
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      *
      * const contextObject = {
      *   animal: 'cat',
@@ -465,7 +465,7 @@ declare module "vm" {
      * the JavaScript [`eval()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval) function to run the same code:
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      * let localVar = 'initial value';
      *
      * const vmResult = vm.runInThisContext('localVar = "vm";');
@@ -492,12 +492,11 @@ declare module "vm" {
      *
      * ```js
      * 'use strict';
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      *
      * const code = `
      * ((require) => {
      *   const http = require('node:http');
-     *
      *   http.createServer((request, response) => {
      *     response.writeHead(200, { 'Content-Type': 'text/plain' });
      *     response.end('Hello World\\n');
@@ -547,7 +546,7 @@ declare module "vm" {
      * the memory occupied by each heap space in the current V8 instance.
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      * // Measure the memory used by the main context.
      * vm.measureMemory({ mode: 'summary' })
      *   // This is the same as vm.measureMemory()
@@ -855,7 +854,7 @@ declare module "vm" {
      * module graphs.
      *
      * ```js
-     * const vm = require('node:vm');
+     * import vm from 'node:vm';
      *
      * const source = '{ "a": 1 }';
      * const module = new vm.SyntheticModule(['default'], function() {

node v20.16/worker_threads.d.ts

@@ -3,7 +3,7 @@
  * JavaScript in parallel. To access it:
  *
  * ```js
- * const worker = require('node:worker_threads');
+ * import worker from 'node:worker_threads';
  * ```
  *
  * Workers (threads) are useful for performing CPU-intensive JavaScript operations.
@@ -14,9 +14,10 @@
  * so by transferring `ArrayBuffer` instances or sharing `SharedArrayBuffer` instances.
  *
  * ```js
- * const {
+ * import {
  *   Worker, isMainThread, parentPort, workerData,
- * } = require('node:worker_threads');
+ * } from 'node:worker_threads';
+ * import { parse } = from 'some-js-parsing-library';
  *
  * if (isMainThread) {
  *   module.exports = function parseJSAsync(script) {
@@ -33,7 +34,6 @@
  *     });
  *   };
  * } else {
- *   const { parse } = require('some-js-parsing-library');
  *   const script = workerData;
  *   parentPort.postMessage(parse(script));
  * }
@@ -72,7 +72,7 @@ declare module "worker_threads" {
      * The `MessageChannel` has no methods of its own. `new MessageChannel()` yields an object with `port1` and `port2` properties, which refer to linked `MessagePort` instances.
      *
      * ```js
-     * const { MessageChannel } = require('node:worker_threads');
+     * import { MessageChannel } from 'node:worker_threads';
      *
      * const { port1, port2 } = new MessageChannel();
      * port1.on('message', (message) => console.log('received', message));
@@ -121,7 +121,7 @@ declare module "worker_threads" {
          * * `value` may not contain native (C++-backed) objects other than:
          *
          * ```js
-         * const { MessageChannel } = require('node:worker_threads');
+         * import { MessageChannel } from 'node:worker_threads';
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -143,7 +143,7 @@ declare module "worker_threads" {
          * `value` may still contain `ArrayBuffer` instances that are not in `transferList`; in that case, the underlying memory is copied rather than moved.
          *
          * ```js
-         * const { MessageChannel } = require('node:worker_threads');
+         * import { MessageChannel } from 'node:worker_threads';
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -298,8 +298,8 @@ declare module "worker_threads" {
      * Notable differences inside a Worker environment are:
      *
      * * The `process.stdin`, `process.stdout`, and `process.stderr` streams may be redirected by the parent thread.
-     * * The `require('node:worker_threads').isMainThread` property is set to `false`.
-     * * The `require('node:worker_threads').parentPort` message port is available.
+     * * The `import { isMainThread } from 'node:worker_threads'` property is set to `false`.
+     * * The `import { parentPort } from 'node:worker_threads'` message port is available.
      * * `process.exit()` does not stop the whole program, just the single thread,
      * and `process.abort()` is not available.
      * * `process.chdir()` and `process` methods that set group or user ids
@@ -334,10 +334,10 @@ declare module "worker_threads" {
      * the thread barrier.
      *
      * ```js
-     * const assert = require('node:assert');
-     * const {
+     * import assert from 'node:assert';
+     * import {
      *   Worker, MessageChannel, MessagePort, isMainThread, parentPort,
-     * } = require('node:worker_threads');
+     * } from 'node:worker_threads';
      * if (isMainThread) {
      *   const worker = new Worker(__filename);
      *   const subChannel = new MessageChannel();
@@ -377,7 +377,7 @@ declare module "worker_threads" {
         readonly stderr: Readable;
         /**
          * An integer identifier for the referenced thread. Inside the worker thread,
-         * it is available as `require('node:worker_threads').threadId`.
+         * it is available as `import { threadId } from 'node:node:worker_threads'`.
          * This value is unique for each `Worker` instance inside a single process.
          * @since v10.5.0
          */
@@ -495,11 +495,11 @@ declare module "worker_threads" {
      * ```js
      * 'use strict';
      *
-     * const {
+     * import {
      *   isMainThread,
      *   BroadcastChannel,
      *   Worker,
-     * } = require('node:worker_threads');
+     * } from 'node:worker_threads';
      *
      * const bc = new BroadcastChannel('hello');
      *
@@ -553,7 +553,7 @@ declare module "worker_threads" {
      * This operation cannot be undone.
      *
      * ```js
-     * const { MessageChannel, markAsUntransferable } = require('node:worker_threads');
+     * import { MessageChannel, markAsUntransferable } from 'node:worker_threads';
      *
      * const pooledBuffer = new ArrayBuffer(8);
      * const typedArray1 = new Uint8Array(pooledBuffer);
@@ -598,7 +598,7 @@ declare module "worker_threads" {
      * that contains the message payload, corresponding to the oldest message in the `MessagePort`'s queue.
      *
      * ```js
-     * const { MessageChannel, receiveMessageOnPort } = require('node:worker_threads');
+     * import { MessageChannel, receiveMessageOnPort } from 'node:worker_threads';
      * const { port1, port2 } = new MessageChannel();
      * port1.postMessage({ hello: 'world' });
      *
@@ -624,12 +624,12 @@ declare module "worker_threads" {
      * automatically.
      *
      * ```js
-     * const {
+     * import {
      *   Worker,
      *   isMainThread,
      *   setEnvironmentData,
      *   getEnvironmentData,
-     * } = require('node:worker_threads');
+     * } from 'node:worker_threads';
      *
      * if (isMainThread) {
      *   setEnvironmentData('Hello', 'World!');
@@ -658,7 +658,7 @@ declare module "worker_threads" {
     } from "worker_threads";
     global {
         /**
-         * `BroadcastChannel` class is a global reference for `require('worker_threads').BroadcastChannel`
+         * `BroadcastChannel` class is a global reference for `import { BroadcastChannel } from 'node:worker_threads'`
          * https://nodejs.org/api/globals.html#broadcastchannel
          * @since v18.0.0
          */
@@ -668,7 +668,7 @@ declare module "worker_threads" {
         } ? T
             : typeof _BroadcastChannel;
         /**
-         * `MessageChannel` class is a global reference for `require('worker_threads').MessageChannel`
+         * `MessageChannel` class is a global reference for `import { MessageChannel } from 'node:worker_threads'`
          * https://nodejs.org/api/globals.html#messagechannel
          * @since v15.0.0
          */
@@ -678,7 +678,7 @@ declare module "worker_threads" {
         } ? T
             : typeof _MessageChannel;
         /**
-         * `MessagePort` class is a global reference for `require('worker_threads').MessagePort`
+         * `MessagePort` class is a global reference for `import { MessagePort } from 'node:worker_threads'`
          * https://nodejs.org/api/globals.html#messageport
          * @since v15.0.0
          */

node v20.16/zlib.d.ts

@@ -5,7 +5,7 @@
  * To access it:
  *
  * ```js
- * const zlib = require('node:zlib');
+ * import zlib from 'node:zlib';
  * ```
  *
  * Compression and decompression are built around the Node.js
@@ -16,12 +16,12 @@
  * stream:
  *
  * ```js
- * const { createGzip } = require('node:zlib');
- * const { pipeline } = require('node:stream');
- * const {
+ * import { createGzip } from 'node:zlib';
+ * import { pipeline } from 'node:stream';
+ * import {
  *   createReadStream,
  *   createWriteStream,
- * } = require('node:fs');
+ * } from 'node:fs';
  *
  * const gzip = createGzip();
  * const source = createReadStream('input.txt');
@@ -36,7 +36,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('node:util');
+ * import { promisify } from 'node:util';
  * const pipe = promisify(pipeline);
  *
  * async function do_gzip(input, output) {
@@ -56,7 +56,7 @@
  * It is also possible to compress or decompress data in a single step:
  *
  * ```js
- * const { deflate, unzip } = require('node:zlib');
+ * import { deflate, unzip } from 'node:zlib';
  *
  * const input = '.................................';
  * deflate(input, (err, buffer) => {
@@ -78,7 +78,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('node:util');
+ * import { promisify } from 'node:util';
  * const do_unzip = promisify(unzip);
  *
  * do_unzip(buffer)