@types/node 18.11.5 → 20.2.5

node/wasi.d.ts

@@ -3,26 +3,23 @@
  * underlying operating system via a collection of POSIX-like functions.
  *
  * ```js
- * import { readFile } from 'fs/promises';
+ * import { readFile } from 'node:fs/promises';
  * import { WASI } from 'wasi';
- * import { argv, env } from 'process';
+ * import { argv, env } from 'node:process';
  *
  * const wasi = new WASI({
+ *   version: 'preview1',
  *   args: argv,
  *   env,
  *   preopens: {
- *     '/sandbox': '/some/real/path/that/wasm/can/access'
- *   }
+ *     '/sandbox': '/some/real/path/that/wasm/can/access',
+ *   },
  * });
  *
- * // Some WASI binaries require:
- * //   const importObject = { wasi_unstable: wasi.wasiImport };
- * const importObject = { wasi_snapshot_preview1: wasi.wasiImport };
- *
  * const wasm = await WebAssembly.compile(
- *   await readFile(new URL('./demo.wasm', import.meta.url))
+ *   await readFile(new URL('./demo.wasm', import.meta.url)),
  * );
- * const instance = await WebAssembly.instantiate(wasm, importObject);
+ * const instance = await WebAssembly.instantiate(wasm, wasi.getImportObject());
  *
  * wasi.start(instance);
  * ```
@@ -64,11 +61,8 @@
  * ```console
  * $ wat2wasm demo.wat
  * ```
- *
- * The `--experimental-wasi-unstable-preview1` CLI argument is needed for this
- * example to run.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/wasi.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/wasi.js)
  */
 declare module 'wasi' {
     interface WASIOptions {
@@ -91,11 +85,11 @@ declare module 'wasi' {
          */
         preopens?: NodeJS.Dict<string> | undefined;
         /**
-         * By default, WASI applications terminate the Node.js
-         * process via the `__wasi_proc_exit()` function. Setting this option to `true`
-         * causes `wasi.start()` to return the exit code rather than terminate the
-         * process.
-         * @default false
+         * By default, when WASI applications call `__wasi_proc_exit()`
+         *  `wasi.start()` will return with the exit code specified rather than terminatng the process.
+         * Setting this option to `false` will cause the Node.js process to exit with
+         * the specified exit code instead.
+         * @default true
          */
         returnOnExit?: boolean | undefined;
         /**

node/worker_threads.d.ts

@@ -1,9 +1,9 @@
 /**
- * The `worker_threads` module enables the use of threads that execute JavaScript
- * in parallel. To access it:
+ * The `node:worker_threads` module enables the use of threads that execute
+ * JavaScript in parallel. To access it:
  *
  * ```js
- * const worker = require('worker_threads');
+ * const worker = require('node:worker_threads');
  * ```
  *
  * Workers (threads) are useful for performing CPU-intensive JavaScript operations.
@@ -15,14 +15,14 @@
  *
  * ```js
  * const {
- *   Worker, isMainThread, parentPort, workerData
- * } = require('worker_threads');
+ *   Worker, isMainThread, parentPort, workerData,
+ * } = require('node:worker_threads');
  *
  * if (isMainThread) {
  *   module.exports = function parseJSAsync(script) {
  *     return new Promise((resolve, reject) => {
  *       const worker = new Worker(__filename, {
- *         workerData: script
+ *         workerData: script,
  *       });
  *       worker.on('message', resolve);
  *       worker.on('error', reject);
@@ -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/v18.0.0/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';
@@ -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('worker_threads');
+     * const { MessageChannel } = require('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('worker_threads');
+         * const { MessageChannel } = require('node:worker_threads');
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -132,7 +132,7 @@ declare module 'worker_threads' {
          * port2.postMessage(circularData);
          * ```
          *
-         * `transferList` may be a list of [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), `MessagePort` and `FileHandle` objects.
+         * `transferList` may be a list of [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), `MessagePort`, and `FileHandle` objects.
          * After transferring, they are not usable on the sending side of the channel
          * anymore (even if they are not contained in `value`). Unlike with `child processes`, transferring handles such as network sockets is currently
          * not supported.
@@ -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('worker_threads');
+         * const { MessageChannel } = require('node:worker_threads');
          * const { port1, port2 } = new MessageChannel();
          *
          * port1.on('message', (message) => console.log(message));
@@ -170,7 +170,7 @@ declare module 'worker_threads' {
          * posting without having side effects.
          *
          * For more information on the serialization and deserialization mechanisms
-         * behind this API, see the `serialization API of the v8 module`.
+         * behind this API, see the `serialization API of the node:v8 module`.
          * @since v10.5.0
          */
         postMessage(value: any, transferList?: ReadonlyArray<TransferListItem>): void;
@@ -262,6 +262,12 @@ declare module 'worker_threads' {
          * @default true
          */
         trackUnmanagedFds?: boolean | undefined;
+        /**
+         * An optional `name` to be appended to the worker title
+         * for debuggin/identification purposes, making the final title as
+         * `[worker ${id}] ${name}`.
+         */
+        name?: string | undefined;
     }
     interface ResourceLimits {
         /**
@@ -288,9 +294,9 @@ declare module 'worker_threads' {
      *
      * Notable differences inside a Worker environment are:
      *
-     * * The `process.stdin`, `process.stdout` and `process.stderr` may be redirected by the parent thread.
-     * * The `require('worker_threads').isMainThread` property is set to `false`.
-     * * The `require('worker_threads').parentPort` message port is available.
+     * * 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.
      * * `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
@@ -307,11 +313,11 @@ declare module 'worker_threads' {
      *
      * Creating `Worker` instances inside of other `Worker`s is possible.
      *
-     * Like [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) and the `cluster module`, two-way communication can be
-     * achieved through inter-thread message passing. Internally, a `Worker` has a
-     * built-in pair of `MessagePort` s that are already associated with each other
-     * when the `Worker` is created. While the `MessagePort` object on the parent side
-     * is not directly exposed, its functionalities are exposed through `worker.postMessage()` and the `worker.on('message')` event
+     * Like [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) and the `node:cluster module`, two-way communication
+     * can be achieved through inter-thread message passing. Internally, a `Worker` has
+     * a built-in pair of `MessagePort` s that are already associated with each
+     * other when the `Worker` is created. While the `MessagePort` object on the parent
+     * side is not directly exposed, its functionalities are exposed through `worker.postMessage()` and the `worker.on('message')` event
      * on the `Worker` object for the parent thread.
      *
      * To create custom messaging channels (which is encouraged over using the default
@@ -324,10 +330,10 @@ declare module 'worker_threads' {
      * the thread barrier.
      *
      * ```js
-     * const assert = require('assert');
+     * const assert = require('node:assert');
      * const {
-     *   Worker, MessageChannel, MessagePort, isMainThread, parentPort
-     * } = require('worker_threads');
+     *   Worker, MessageChannel, MessagePort, isMainThread, parentPort,
+     * } = require('node:worker_threads');
      * if (isMainThread) {
      *   const worker = new Worker(__filename);
      *   const subChannel = new MessageChannel();
@@ -367,7 +373,7 @@ declare module 'worker_threads' {
         readonly stderr: Readable;
         /**
          * An integer identifier for the referenced thread. Inside the worker thread,
-         * it is available as `require('worker_threads').threadId`.
+         * it is available as `require('node:worker_threads').threadId`.
          * This value is unique for each `Worker` instance inside a single process.
          * @since v10.5.0
          */
@@ -394,7 +400,7 @@ declare module 'worker_threads' {
          */
         constructor(filename: string | URL, options?: WorkerOptions);
         /**
-         * Send a message to the worker that is received via `require('worker_threads').parentPort.on('message')`.
+         * Send a message to the worker that is received via `require('node:worker_threads').parentPort.on('message')`.
          * See `port.postMessage()` for more details.
          * @since v10.5.0
          */
@@ -488,8 +494,8 @@ declare module 'worker_threads' {
      * const {
      *   isMainThread,
      *   BroadcastChannel,
-     *   Worker
-     * } = require('worker_threads');
+     *   Worker,
+     * } = require('node:worker_threads');
      *
      * const bc = new BroadcastChannel('hello');
      *
@@ -543,7 +549,7 @@ declare module 'worker_threads' {
      * This operation cannot be undone.
      *
      * ```js
-     * const { MessageChannel, markAsUntransferable } = require('worker_threads');
+     * const { MessageChannel, markAsUntransferable } = require('node:worker_threads');
      *
      * const pooledBuffer = new ArrayBuffer(8);
      * const typedArray1 = new Uint8Array(pooledBuffer);
@@ -585,10 +591,10 @@ declare module 'worker_threads' {
     function moveMessagePortToContext(port: MessagePort, contextifiedSandbox: Context): MessagePort;
     /**
      * Receive a single message from a given `MessagePort`. If no message is available,`undefined` is returned, otherwise an object with a single `message` property
-     * that contains the message payload, corresponding to the oldest message in the`MessagePort`’s queue.
+     * that contains the message payload, corresponding to the oldest message in the`MessagePort`'s queue.
      *
      * ```js
-     * const { MessageChannel, receiveMessageOnPort } = require('worker_threads');
+     * const { MessageChannel, receiveMessageOnPort } = require('node:worker_threads');
      * const { port1, port2 } = new MessageChannel();
      * port1.postMessage({ hello: 'world' });
      *
@@ -619,7 +625,7 @@ declare module 'worker_threads' {
      *   isMainThread,
      *   setEnvironmentData,
      *   getEnvironmentData,
-     * } = require('worker_threads');
+     * } = require('node:worker_threads');
      *
      * if (isMainThread) {
      *   setEnvironmentData('Hello', 'World!');
@@ -658,7 +664,6 @@ declare module 'worker_threads' {
         }
             ? T
             : typeof _BroadcastChannel;
-
         /**
          * `MessageChannel` class is a global reference for `require('worker_threads').MessageChannel`
          * https://nodejs.org/api/globals.html#messagechannel
@@ -670,13 +675,12 @@ declare module 'worker_threads' {
         }
             ? T
             : typeof _MessageChannel;
-
         /**
          * `MessagePort` class is a global reference for `require('worker_threads').MessagePort`
          * https://nodejs.org/api/globals.html#messageport
          * @since v15.0.0
          */
-         var MessagePort: typeof globalThis extends {
+        var MessagePort: typeof globalThis extends {
             onmessage: any;
             MessagePort: infer T;
         }

node/zlib.d.ts

@@ -1,11 +1,11 @@
 /**
- * The `zlib` module provides compression functionality implemented using Gzip,
- * Deflate/Inflate, and Brotli.
+ * The `node:zlib` module provides compression functionality implemented using
+ * Gzip, Deflate/Inflate, and Brotli.
  *
  * To access it:
  *
  * ```js
- * const zlib = require('zlib');
+ * const zlib = require('node:zlib');
  * ```
  *
  * Compression and decompression are built around the Node.js `Streams API`.
@@ -15,12 +15,12 @@
  * stream:
  *
  * ```js
- * const { createGzip } = require('zlib');
- * const { pipeline } = require('stream');
+ * const { createGzip } = require('node:zlib');
+ * const { pipeline } = require('node:stream');
  * const {
  *   createReadStream,
- *   createWriteStream
- * } = require('fs');
+ *   createWriteStream,
+ * } = require('node:fs');
  *
  * const gzip = createGzip();
  * const source = createReadStream('input.txt');
@@ -35,7 +35,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('util');
+ * const { promisify } = require('node:util');
  * const pipe = promisify(pipeline);
  *
  * async function do_gzip(input, output) {
@@ -55,7 +55,7 @@
  * It is also possible to compress or decompress data in a single step:
  *
  * ```js
- * const { deflate, unzip } = require('zlib');
+ * const { deflate, unzip } = require('node:zlib');
  *
  * const input = '.................................';
  * deflate(input, (err, buffer) => {
@@ -77,7 +77,7 @@
  *
  * // Or, Promisified
  *
- * const { promisify } = require('util');
+ * const { promisify } = require('node:util');
  * const do_unzip = promisify(unzip);
  *
  * do_unzip(buffer)
@@ -88,7 +88,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/zlib.js)
  */
 declare module 'zlib' {
     import * as stream from 'node:stream';