@types/node 20.5.9 → 20.6.0

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Sat, 02 Sep 2023 20:02:59 GMT
+ * Last updated: Fri, 08 Sep 2023 21:33:18 GMT
  * Dependencies: none
  * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
 

node/async_hooks.d.ts

@@ -21,6 +21,7 @@ declare module 'async_hooks' {
      * import fs from 'node:fs';
      *
      * console.log(executionAsyncId());  // 1 - bootstrap
+     * const path = '.';
      * fs.open(path, 'r', (err, fd) => {
      *   console.log(executionAsyncId());  // 6 - open()
      * });

node/fs.d.ts

@@ -3924,17 +3924,22 @@ declare module 'fs' {
     }
 
     /**
-     * Returns a Blob whose data is backed by the given file.
+     * Returns a `Blob` whose data is backed by the given file.
      *
-     * The file must not be modified after the `Blob` is created.
-     * Any modifications will cause reading the `Blob` data to fail with a `DOMException` error.
-     * Synchronous stat operations on the file when the `Blob` is created, and before each read in order to detect whether the file data has been modified on disk.
+     * The file must not be modified after the `Blob` is created. Any modifications
+     * will cause reading the `Blob` data to fail with a `DOMException` error.
+     * Synchronous stat operations on the file when the `Blob` is created, and before
+     * each read in order to detect whether the file data has been modified on disk.
      *
-     * @param path
-     * @param [options]
+     * ```js
+     * import { openAsBlob } from 'node:fs';
      *
-     * @experimental
+     * const blob = await openAsBlob('the.file.txt');
+     * const ab = await blob.arrayBuffer();
+     * blob.stream();
+     * ```
      * @since v19.8.0
+     * @experimental
      */
     export function openAsBlob(path: PathLike, options?: OpenAsBlobOptions): Promise<Blob>;
 

node/http.d.ts

@@ -803,7 +803,7 @@ declare module 'http' {
          * may run into a 'ECONNRESET' error.
          *
          * ```js
-         * const http = require('node:http');
+         * import http from 'node:http';
          *
          * // Server has a 5 seconds keep-alive timeout by default
          * http
@@ -827,7 +827,7 @@ declare module 'http' {
          * automatic error retry base on it.
          *
          * ```js
-         * const http = require('node:http');
+         * import http from 'node:http';
          * const agent = new http.Agent({ keepAlive: true });
          *
          * function retriableRequest() {
@@ -1375,6 +1375,37 @@ declare module 'http' {
      *
      * The `requestListener` is a function which is automatically
      * added to the `'request'` event.
+     *
+     * ```js
+     * import http from 'node:http';
+     *
+     * // Create a local server to receive data from
+     * const server = http.createServer((req, res) => {
+     *   res.writeHead(200, { 'Content-Type': 'application/json' });
+     *   res.end(JSON.stringify({
+     *     data: 'Hello World!',
+     *   }));
+     * });
+     *
+     * server.listen(8000);
+     * ```
+     *
+     * ```js
+     * import http from 'node:http';
+     *
+     * // Create a local server to receive data from
+     * const server = http.createServer();
+     *
+     * // Listen to the request event
+     * server.on('request', (request, res) => {
+     *   res.writeHead(200, { 'Content-Type': 'application/json' });
+     *   res.end(JSON.stringify({
+     *     data: 'Hello World!',
+     *   }));
+     * });
+     *
+     * server.listen(8000);
+     * ```
      * @since v0.1.13
      */
     function createServer<
@@ -1409,7 +1440,8 @@ declare module 'http' {
      * upload a file with a POST request, then write to the `ClientRequest` object.
      *
      * ```js
-     * const http = require('node:http');
+     * import http from 'node:http';
+     * import { Buffer } from 'node:buffer';
      *
      * const postData = JSON.stringify({
      *   'msg': 'Hello World!',
@@ -1582,8 +1614,8 @@ declare module 'http' {
     function request(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
     /**
      * Since most requests are GET requests without bodies, Node.js provides this
-     * convenience method. The only difference between this method and {@link request} is that it sets the method to GET and calls `req.end()`automatically. The callback must take care to consume the
-     * response
+     * convenience method. The only difference between this method and {@link request} is that it sets the method to GET by default and calls `req.end()`automatically. The callback must take care to
+     * consume the response
      * data for reasons stated in {@link ClientRequest} section.
      *
      * The `callback` is invoked with a single argument that is an instance of {@link IncomingMessage}.
@@ -1638,7 +1670,7 @@ declare module 'http' {
      * server.listen(8000);
      * ```
      * @since v0.3.6
-     * @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`. Properties that are inherited from the prototype are ignored.
+     * @param options Accepts the same `options` as {@link request}, with the method set to GET by default.
      */
     function get(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest;
     function get(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
@@ -1655,7 +1687,7 @@ declare module 'http' {
      * Example:
      *
      * ```js
-     * const { validateHeaderName } = require('node:http');
+     * import { validateHeaderName } from 'node:http';
      *
      * try {
      *   validateHeaderName('');
@@ -1683,7 +1715,7 @@ declare module 'http' {
      * Examples:
      *
      * ```js
-     * const { validateHeaderValue } = require('node:http');
+     * import { validateHeaderValue } from 'node:http';
      *
      * try {
      *   validateHeaderValue('x-my-header', undefined);

node/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for non-npm package Node.js 20.5
+// Type definitions for non-npm package Node.js 20.6
 // Project: https://nodejs.org/
 // Definitions by: Microsoft TypeScript <https://github.com/Microsoft>
 //                 DefinitelyTyped <https://github.com/DefinitelyTyped>

node/inspector.d.ts

@@ -2705,8 +2705,9 @@ declare module 'inspector' {
      * @param [port='what was specified on the CLI'] Port to listen on for inspector connections. Optional.
      * @param [host='what was specified on the CLI'] Host to listen on for inspector connections. Optional.
      * @param [wait=false] Block until a client has connected. Optional.
+     * @returns Disposable that calls `inspector.close()`.
      */
-    function open(port?: number, host?: string, wait?: boolean): void;
+    function open(port?: number, host?: string, wait?: boolean): Disposable;
     /**
      * Deactivate the inspector. Blocks until there are no active connections.
      */

node/module.d.ts

@@ -102,6 +102,9 @@ declare module 'module' {
             port: MessagePort;
         }
         /**
+         * @deprecated This hook will be removed in a future version.
+         * Use `initialize` instead. When a loader has an `initialize` export, `globalPreload` will be ignored.
+         *
          * Sometimes it might be necessary to run some code inside of the same global scope that the application runs in.
          * This hook allows the return of a string that is run as a sloppy-mode script on startup.
          *
@@ -109,6 +112,14 @@ declare module 'module' {
          * @return Code to run before application startup
          */
         type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
+        /**
+         * The `initialize` hook provides a way to define a custom function that runs in the loader's thread
+         * when the loader is initialized. Initialization happens when the loader is registered via `register`
+         * or registered via the `--experimental-loader` command line option.
+         *
+         * This hook can send and receive data from a `register` invocation, including ports and other transferrable objects.
+         */
+        type InitializeHook<Data = any, ReturnType = any> = (data: Data) => ReturnType;
         interface ResolveHookContext {
             /**
              * Export conditions of the relevant `package.json`
@@ -196,6 +207,11 @@ declare module 'module' {
             nextLoad: (url: string, context?: LoadHookContext) => LoadFnOutput | Promise<LoadFnOutput>
         ) => LoadFnOutput | Promise<LoadFnOutput>;
     }
+    interface RegisterOptions<Data> {
+        parentURL: string;
+        data?: Data | undefined;
+        transferList?: any[] | undefined;
+    }
     interface Module extends NodeModule {}
     class Module {
         static runMain(): void;
@@ -204,13 +220,22 @@ declare module 'module' {
         static builtinModules: string[];
         static isBuiltin(moduleName: string): boolean;
         static Module: typeof Module;
+        static register<Data = any, ReturnType = any>(specifier: string, parentURL?: string, options?: RegisterOptions<Data>): ReturnType;
+        static register<Data = any, ReturnType = any>(specifier: string, options?: RegisterOptions<Data>): ReturnType;
         constructor(id: string, parent?: Module);
     }
     global {
         interface ImportMeta {
             url: string;
             /**
-             * @experimental
+             * Provides a module-relative resolution function scoped to each module, returning
+             * the URL string.
+             *
+             * @param specified The module specifier to resolve relative to the current module.
+             * @returns The absolute (`file:`) URL string for the resolved module.
+             */
+            resolve(specified: string): string;
+            /**
              * This feature is only available with the `--experimental-import-meta-resolve`
              * command flag enabled.
              *
@@ -218,10 +243,10 @@ declare module 'module' {
              * the URL string.
              *
              * @param specified The module specifier to resolve relative to `parent`.
-             * @param parent The absolute parent module URL to resolve from. If none
-             * is specified, the value of `import.meta.url` is used as the default.
+             * @param parent The absolute parent module URL to resolve from.
+             * @returns The absolute (`file:`) URL string for the resolved module.
              */
-            resolve?(specified: string, parent?: string | URL): Promise<string>;
+            resolve(specified: string, parent: string | URL): string;
         }
     }
     export = Module;

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "20.5.9",
+    "version": "20.6.0",
     "description": "TypeScript definitions for Node.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -227,6 +227,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "b81b4a667392c6db4f92b6520158fccbce2770eefa3b0e03de5624b811f81649",
+    "typesPublisherContentHash": "70cf00335399b8a54dc9af673836cb1cc5d7c049940d67d8c9db01bd10ee989f",
     "typeScriptVersion": "4.3"
 }

node/process.d.ts

@@ -546,7 +546,8 @@ declare module 'process' {
                  * parent thread's `process.env`, or whatever was specified as the `env` option
                  * to the `Worker` constructor. Changes to `process.env` will not be visible
                  * across `Worker` threads, and only the main thread can make changes that
-                 * are visible to the operating system or to native add-ons.
+                 * are visible to the operating system or to native add-ons. On Windows, a copy of`process.env` on a `Worker` instance operates in a case-sensitive manner
+                 * unlike the main thread.
                  * @since v0.1.27
                  */
                 env: ProcessEnv;
@@ -1275,7 +1276,7 @@ declare module 'process' {
                  * If Node.js is spawned with an IPC channel, the `process.send()` method can be
                  * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object.
                  *
-                 * If Node.js was not spawned with an IPC channel, `process.send` will be`undefined`.
+                 * If Node.js was not spawned with an IPC channel, `process.send` will be `undefined`.
                  *
                  * The message goes through serialization and parsing. The resulting message might
                  * not be the same as what is originally sent.

node/ts4.8/async_hooks.d.ts

@@ -21,6 +21,7 @@ declare module 'async_hooks' {
      * import fs from 'node:fs';
      *
      * console.log(executionAsyncId());  // 1 - bootstrap
+     * const path = '.';
      * fs.open(path, 'r', (err, fd) => {
      *   console.log(executionAsyncId());  // 6 - open()
      * });

node/ts4.8/fs.d.ts

@@ -3924,17 +3924,22 @@ declare module 'fs' {
     }
 
     /**
-     * Returns a Blob whose data is backed by the given file.
+     * Returns a `Blob` whose data is backed by the given file.
      *
-     * The file must not be modified after the `Blob` is created.
-     * Any modifications will cause reading the `Blob` data to fail with a `DOMException` error.
-     * Synchronous stat operations on the file when the `Blob` is created, and before each read in order to detect whether the file data has been modified on disk.
+     * The file must not be modified after the `Blob` is created. Any modifications
+     * will cause reading the `Blob` data to fail with a `DOMException` error.
+     * Synchronous stat operations on the file when the `Blob` is created, and before
+     * each read in order to detect whether the file data has been modified on disk.
      *
-     * @param path
-     * @param [options]
+     * ```js
+     * import { openAsBlob } from 'node:fs';
      *
-     * @experimental
+     * const blob = await openAsBlob('the.file.txt');
+     * const ab = await blob.arrayBuffer();
+     * blob.stream();
+     * ```
      * @since v19.8.0
+     * @experimental
      */
     export function openAsBlob(path: PathLike, options?: OpenAsBlobOptions): Promise<Blob>;
 

node/ts4.8/http.d.ts

@@ -803,7 +803,7 @@ declare module 'http' {
          * may run into a 'ECONNRESET' error.
          *
          * ```js
-         * const http = require('node:http');
+         * import http from 'node:http';
          *
          * // Server has a 5 seconds keep-alive timeout by default
          * http
@@ -827,7 +827,7 @@ declare module 'http' {
          * automatic error retry base on it.
          *
          * ```js
-         * const http = require('node:http');
+         * import http from 'node:http';
          * const agent = new http.Agent({ keepAlive: true });
          *
          * function retriableRequest() {
@@ -1375,6 +1375,37 @@ declare module 'http' {
      *
      * The `requestListener` is a function which is automatically
      * added to the `'request'` event.
+     *
+     * ```js
+     * import http from 'node:http';
+     *
+     * // Create a local server to receive data from
+     * const server = http.createServer((req, res) => {
+     *   res.writeHead(200, { 'Content-Type': 'application/json' });
+     *   res.end(JSON.stringify({
+     *     data: 'Hello World!',
+     *   }));
+     * });
+     *
+     * server.listen(8000);
+     * ```
+     *
+     * ```js
+     * import http from 'node:http';
+     *
+     * // Create a local server to receive data from
+     * const server = http.createServer();
+     *
+     * // Listen to the request event
+     * server.on('request', (request, res) => {
+     *   res.writeHead(200, { 'Content-Type': 'application/json' });
+     *   res.end(JSON.stringify({
+     *     data: 'Hello World!',
+     *   }));
+     * });
+     *
+     * server.listen(8000);
+     * ```
      * @since v0.1.13
      */
     function createServer<
@@ -1409,7 +1440,8 @@ declare module 'http' {
      * upload a file with a POST request, then write to the `ClientRequest` object.
      *
      * ```js
-     * const http = require('node:http');
+     * import http from 'node:http';
+     * import { Buffer } from 'node:buffer';
      *
      * const postData = JSON.stringify({
      *   'msg': 'Hello World!',
@@ -1582,8 +1614,8 @@ declare module 'http' {
     function request(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
     /**
      * Since most requests are GET requests without bodies, Node.js provides this
-     * convenience method. The only difference between this method and {@link request} is that it sets the method to GET and calls `req.end()`automatically. The callback must take care to consume the
-     * response
+     * convenience method. The only difference between this method and {@link request} is that it sets the method to GET by default and calls `req.end()`automatically. The callback must take care to
+     * consume the response
      * data for reasons stated in {@link ClientRequest} section.
      *
      * The `callback` is invoked with a single argument that is an instance of {@link IncomingMessage}.
@@ -1638,7 +1670,7 @@ declare module 'http' {
      * server.listen(8000);
      * ```
      * @since v0.3.6
-     * @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`. Properties that are inherited from the prototype are ignored.
+     * @param options Accepts the same `options` as {@link request}, with the method set to GET by default.
      */
     function get(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest;
     function get(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
@@ -1655,7 +1687,7 @@ declare module 'http' {
      * Example:
      *
      * ```js
-     * const { validateHeaderName } = require('node:http');
+     * import { validateHeaderName } from 'node:http';
      *
      * try {
      *   validateHeaderName('');
@@ -1683,7 +1715,7 @@ declare module 'http' {
      * Examples:
      *
      * ```js
-     * const { validateHeaderValue } = require('node:http');
+     * import { validateHeaderValue } from 'node:http';
      *
      * try {
      *   validateHeaderValue('x-my-header', undefined);

node/ts4.8/inspector.d.ts

@@ -2705,8 +2705,9 @@ declare module 'inspector' {
      * @param [port='what was specified on the CLI'] Port to listen on for inspector connections. Optional.
      * @param [host='what was specified on the CLI'] Host to listen on for inspector connections. Optional.
      * @param [wait=false] Block until a client has connected. Optional.
+     * @returns Disposable that calls `inspector.close()`.
      */
-    function open(port?: number, host?: string, wait?: boolean): void;
+    function open(port?: number, host?: string, wait?: boolean): Disposable;
     /**
      * Deactivate the inspector. Blocks until there are no active connections.
      */

node/ts4.8/module.d.ts

@@ -102,6 +102,9 @@ declare module 'module' {
             port: MessagePort;
         }
         /**
+         * @deprecated This hook will be removed in a future version.
+         * Use `initialize` instead. When a loader has an `initialize` export, `globalPreload` will be ignored.
+         *
          * Sometimes it might be necessary to run some code inside of the same global scope that the application runs in.
          * This hook allows the return of a string that is run as a sloppy-mode script on startup.
          *
@@ -109,6 +112,14 @@ declare module 'module' {
          * @return Code to run before application startup
          */
         type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
+        /**
+         * The `initialize` hook provides a way to define a custom function that runs in the loader's thread
+         * when the loader is initialized. Initialization happens when the loader is registered via `register`
+         * or registered via the `--experimental-loader` command line option.
+         *
+         * This hook can send and receive data from a `register` invocation, including ports and other transferrable objects.
+         */
+        type InitializeHook<Data = any, ReturnType = any> = (data: Data) => ReturnType;
         interface ResolveHookContext {
             /**
              * Export conditions of the relevant `package.json`
@@ -196,6 +207,11 @@ declare module 'module' {
             nextLoad: (url: string, context?: LoadHookContext) => LoadFnOutput | Promise<LoadFnOutput>
         ) => LoadFnOutput | Promise<LoadFnOutput>;
     }
+    interface RegisterOptions<Data> {
+        parentURL: string;
+        data?: Data | undefined;
+        transferList?: any[] | undefined;
+    }
     interface Module extends NodeModule {}
     class Module {
         static runMain(): void;
@@ -204,13 +220,22 @@ declare module 'module' {
         static builtinModules: string[];
         static isBuiltin(moduleName: string): boolean;
         static Module: typeof Module;
+        static register<Data = any, ReturnType = any>(specifier: string, parentURL?: string, options?: RegisterOptions<Data>): ReturnType;
+        static register<Data = any, ReturnType = any>(specifier: string, options?: RegisterOptions<Data>): ReturnType;
         constructor(id: string, parent?: Module);
     }
     global {
         interface ImportMeta {
             url: string;
             /**
-             * @experimental
+             * Provides a module-relative resolution function scoped to each module, returning
+             * the URL string.
+             *
+             * @param specified The module specifier to resolve relative to the current module.
+             * @returns The absolute (`file:`) URL string for the resolved module.
+             */
+            resolve(specified: string): string;
+            /**
              * This feature is only available with the `--experimental-import-meta-resolve`
              * command flag enabled.
              *
@@ -218,10 +243,10 @@ declare module 'module' {
              * the URL string.
              *
              * @param specified The module specifier to resolve relative to `parent`.
-             * @param parent The absolute parent module URL to resolve from. If none
-             * is specified, the value of `import.meta.url` is used as the default.
+             * @param parent The absolute parent module URL to resolve from.
+             * @returns The absolute (`file:`) URL string for the resolved module.
              */
-            resolve?(specified: string, parent?: string | URL): Promise<string>;
+            resolve(specified: string, parent: string | URL): string;
         }
     }
     export = Module;

node/ts4.8/process.d.ts

@@ -546,7 +546,8 @@ declare module 'process' {
                  * parent thread's `process.env`, or whatever was specified as the `env` option
                  * to the `Worker` constructor. Changes to `process.env` will not be visible
                  * across `Worker` threads, and only the main thread can make changes that
-                 * are visible to the operating system or to native add-ons.
+                 * are visible to the operating system or to native add-ons. On Windows, a copy of`process.env` on a `Worker` instance operates in a case-sensitive manner
+                 * unlike the main thread.
                  * @since v0.1.27
                  */
                 env: ProcessEnv;
@@ -1275,7 +1276,7 @@ declare module 'process' {
                  * If Node.js is spawned with an IPC channel, the `process.send()` method can be
                  * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object.
                  *
-                 * If Node.js was not spawned with an IPC channel, `process.send` will be`undefined`.
+                 * If Node.js was not spawned with an IPC channel, `process.send` will be `undefined`.
                  *
                  * The message goes through serialization and parsing. The resulting message might
                  * not be the same as what is originally sent.

node/ts4.8/worker_threads.d.ts

@@ -303,7 +303,8 @@ declare module 'worker_threads' {
      * are not available.
      * * `process.env` is a copy of the parent thread's environment variables,
      * unless otherwise specified. Changes to one copy are not visible in other
-     * threads, and are not visible to native add-ons (unless `worker.SHARE_ENV` is passed as the `env` option to the `Worker` constructor).
+     * threads, and are not visible to native add-ons (unless `worker.SHARE_ENV` is passed as the `env` option to the `Worker` constructor). On Windows, unlike the main thread, a copy of the
+     * environment variables operates in a case-sensitive manner.
      * * `process.title` cannot be modified.
      * * Signals are not delivered through `process.on('...')`.
      * * Execution may stop at any point as a result of `worker.terminate()` being invoked.

node/worker_threads.d.ts

@@ -303,7 +303,8 @@ declare module 'worker_threads' {
      * are not available.
      * * `process.env` is a copy of the parent thread's environment variables,
      * unless otherwise specified. Changes to one copy are not visible in other
-     * threads, and are not visible to native add-ons (unless `worker.SHARE_ENV` is passed as the `env` option to the `Worker` constructor).
+     * threads, and are not visible to native add-ons (unless `worker.SHARE_ENV` is passed as the `env` option to the `Worker` constructor). On Windows, unlike the main thread, a copy of the
+     * environment variables operates in a case-sensitive manner.
      * * `process.title` cannot be modified.
      * * Signals are not delivered through `process.on('...')`.
      * * Execution may stop at any point as a result of `worker.terminate()` being invoked.