@types/node 18.8.4 → 18.11.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: Mon, 10 Oct 2022 21:33:31 GMT
+ * Last updated: Fri, 14 Oct 2022 20:32:59 GMT
  * Dependencies: none
  * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
 

node/buffer.d.ts

@@ -166,7 +166,11 @@ declare module 'buffer' {
     export import atob = globalThis.atob;
     export import btoa = globalThis.btoa;
 
-    import { Blob as _Blob } from 'buffer';
+    import { Blob as NodeBlob } from 'buffer';
+    // This conditional type will be the existing global Blob in a browser, or
+    // the copy below in a Node environment.
+    type __Blob = typeof globalThis extends { onmessage: any, Blob: infer T }
+        ? T : NodeBlob;
     global {
         // Buffer class
         type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex';
@@ -2235,6 +2239,7 @@ declare module 'buffer' {
          */
         function btoa(data: string): string;
 
+        interface Blob extends __Blob {}
         /**
          * `Blob` class is a global reference for `require('node:buffer').Blob`
          * https://nodejs.org/api/buffer.html#class-blob
@@ -2245,7 +2250,7 @@ declare module 'buffer' {
             Blob: infer T;
         }
             ? T
-            : typeof _Blob;
+            : typeof NodeBlob;
     }
 }
 declare module 'node:buffer' {

node/crypto.d.ts

@@ -3723,7 +3723,9 @@ declare module 'crypto' {
             /**
              * Using the method and parameters specified in `algorithm` and the keying material provided by `baseKey`,
              * `subtle.deriveBits()` attempts to generate `length` bits.
-             * The Node.js implementation requires that `length` is a multiple of `8`.
+             * The Node.js implementation requires that when `length` is a number it must be multiple of `8`.
+             * When `length` is `null` the maximum number of bits for a given algorithm is generated. This is allowed
+             * for the `'ECDH'`, `'X25519'`, and `'X448'` algorithms.
              * If successful, the returned promise will be resolved with an `<ArrayBuffer>` containing the generated data.
              *
              * The algorithms currently supported include:
@@ -3735,7 +3737,8 @@ declare module 'crypto' {
              * - `'PBKDF2'`
              * @since v15.0.0
              */
-            deriveBits(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>;
+            deriveBits(algorithm: EcdhKeyDeriveParams, baseKey: CryptoKey, length: number | null): Promise<ArrayBuffer>;
+            deriveBits(algorithm: AlgorithmIdentifier | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>;
             /**
              * Using the method and parameters specified in `algorithm`, and the keying material provided by `baseKey`,
              * `subtle.deriveKey()` attempts to generate a new <CryptoKey>` based on the method and parameters in `derivedKeyAlgorithm`.

node/fs/promises.d.ts

@@ -37,6 +37,7 @@ declare module 'fs/promises' {
         WriteStream,
         WriteVResult,
     } from 'node:fs';
+    import { Interface as ReadlineInterface } from 'node:readline';
 
     interface FileChangeInfo<T extends string | Buffer> {
         eventType: WatchEventType;
@@ -284,6 +285,23 @@ declare module 'fs/promises' {
                 | BufferEncoding
                 | null
         ): Promise<string | Buffer>;
+        /**
+         * Convenience method to create a `readline` interface and stream over the file. For example:
+         *
+         * ```js
+         * import { open } from 'node:fs/promises';
+         *
+         * const file = await open('./some/file/to/read');
+         *
+         * for await (const line of file.readLines()) {
+         *   console.log(line);
+         * }
+         * ```
+         *
+         * @since v18.11.0
+         * @param options See `filehandle.createReadStream()` for the options.
+         */
+        readLines(options?: CreateReadStreamOptions): ReadlineInterface;
         /**
          * @since v10.0.0
          * @return Fulfills with an {fs.Stats} for the file.

node/http.d.ts

@@ -570,11 +570,46 @@ declare module 'http' {
         assignSocket(socket: Socket): void;
         detachSocket(socket: Socket): void;
         /**
-         * Sends a HTTP/1.1 100 Continue message to the client, indicating that
+         * Sends an HTTP/1.1 100 Continue message to the client, indicating that
          * the request body should be sent. See the `'checkContinue'` event on`Server`.
          * @since v0.3.0
          */
         writeContinue(callback?: () => void): void;
+        /**
+         * Sends an HTTP/1.1 103 Early Hints message to the client with a Link header,
+         * indicating that the user agent can preload/preconnect the linked resources.
+         * The `hints` is an object containing the values of headers to be sent with
+         * early hints message. The optional `callback` argument will be called when
+         * the response message has been written.
+         *
+         * Example:
+         *
+         * ```js
+         * const earlyHintsLink = '</styles.css>; rel=preload; as=style';
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLink,
+         * });
+         *
+         * const earlyHintsLinks = [
+         *   '</styles.css>; rel=preload; as=style',
+         *   '</scripts.js>; rel=preload; as=script',
+         * ];
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks,
+         *   'x-trace-id': 'id for diagnostics'
+         * });
+         *
+         * const earlyHintsCallback = () => console.log('early hints message sent');
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks
+         * }, earlyHintsCallback);
+         * ```
+         *
+         * @since v18.11.0
+         * @param hints An object containing the values of headers
+         * @param callback Will be called when the response message has been written
+         */
+        writeEarlyHints(hints: Record<string, string | string[]>, callback?: () => void): void;
         /**
          * Sends a response header to the request. The status code is a 3-digit HTTP
          * status code, like `404`. The last argument, `headers`, are the response headers.
@@ -639,7 +674,7 @@ declare module 'http' {
         ): this;
         writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this;
         /**
-         * Sends a HTTP/1.1 102 Processing message to the client, indicating that
+         * Sends an HTTP/1.1 102 Processing message to the client, indicating that
          * the request body should be sent.
          * @since v10.0.0
          */

node/http2.d.ts

@@ -1670,6 +1670,34 @@ declare module 'http2' {
          * @since v8.4.0
          */
         writeContinue(): void;
+        /**
+         * Sends a status `103 Early Hints` to the client with a Link header,
+         * indicating that the user agent can preload/preconnect the linked resources.
+         * The `hints` is an object containing the values of headers to be sent with
+         * early hints message.
+         *
+         * Example:
+         *
+         * ```js
+         * const earlyHintsLink = '</styles.css>; rel=preload; as=style';
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLink,
+         * });
+         *
+         * const earlyHintsLinks = [
+         *   '</styles.css>; rel=preload; as=style',
+         *   '</scripts.js>; rel=preload; as=script',
+         * ];
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks,
+         *   'x-trace-id': 'id for diagnostics'
+         * });
+         * ```
+         *
+         * @since v18.11.0
+         * @param hints An object containing the values of headers
+         */
+        writeEarlyHints(hints: Record<string, string | string[]>): void;
         /**
          * Sends a response header to the request. The status code is a 3-digit HTTP
          * status code, like `404`. The last argument, `headers`, are the response headers.

node/index.d.ts

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

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "18.8.4",
+    "version": "18.11.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": "c77acbd7196d2ac8a09c9dbff0f75aabaead5468c1cfd9d9db404e7f6989deac",
+    "typesPublisherContentHash": "bec614c152bf72c7a29b996ba58cf8e86e92e1371bf820fac0654a49a16fce5f",
     "typeScriptVersion": "4.1"
 }

node/path.d.ts

@@ -122,10 +122,10 @@ declare module 'path' {
              * Often used to extract the file name from a fully qualified path.
              *
              * @param path the path to evaluate.
-             * @param ext optionally, an extension to remove from the result.
+             * @param suffix optionally, an extension to remove from the result.
              * @throws {TypeError} if `path` is not a string or if `ext` is given and is not a string.
              */
-            basename(path: string, ext?: string): string;
+            basename(path: string, suffix?: string): string;
             /**
              * Return the extension of the path, from the last '.' to end of string in the last portion of the path.
              * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.

node/stream.d.ts

@@ -18,7 +18,7 @@
  */
 declare module 'stream' {
     import { EventEmitter, Abortable } from 'node:events';
-    import { Blob } from "node:buffer";
+    import { Blob as NodeBlob } from "node:buffer";
     import * as streamPromises from 'node:stream/promises';
     import * as streamConsumers from 'node:stream/consumers';
     import * as streamWeb from 'node:stream/web';
@@ -893,7 +893,7 @@ declare module 'stream' {
              *
              * @since v16.8.0
              */
-            static from(src: Stream | Blob | ArrayBuffer | string | Iterable<any> | AsyncIterable<any> | AsyncGeneratorFunction | Promise<any> | Object): Duplex;
+            static from(src: Stream | NodeBlob | ArrayBuffer | string | Iterable<any> | AsyncIterable<any> | AsyncGeneratorFunction | Promise<any> | Object): Duplex;
             _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
             _writev?(
                 chunks: Array<{

node/ts4.8/buffer.d.ts

@@ -166,7 +166,12 @@ declare module 'buffer' {
     export import atob = globalThis.atob;
     export import btoa = globalThis.btoa;
 
-    import { Blob as _Blob } from 'buffer';
+    import { Blob as NodeBlob } from 'buffer';
+    // This conditional type will be the existing global Blob in a browser, or
+    // the copy below in a Node environment.
+    type __Blob = typeof globalThis extends { onmessage: any, Blob: infer T }
+        ? T : NodeBlob;
+
     global {
         // Buffer class
         type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex';
@@ -2235,6 +2240,7 @@ declare module 'buffer' {
          */
         function btoa(data: string): string;
 
+        interface Blob extends __Blob {}
         /**
          * `Blob` class is a global reference for `require('node:buffer').Blob`
          * https://nodejs.org/api/buffer.html#class-blob
@@ -2245,7 +2251,7 @@ declare module 'buffer' {
             Blob: infer T;
         }
             ? T
-            : typeof _Blob;
+            : typeof NodeBlob;
     }
 }
 declare module 'node:buffer' {

node/ts4.8/crypto.d.ts

@@ -3723,7 +3723,9 @@ declare module 'crypto' {
             /**
              * Using the method and parameters specified in `algorithm` and the keying material provided by `baseKey`,
              * `subtle.deriveBits()` attempts to generate `length` bits.
-             * The Node.js implementation requires that `length` is a multiple of `8`.
+             * The Node.js implementation requires that when `length` is a number it must be multiple of `8`.
+             * When `length` is `null` the maximum number of bits for a given algorithm is generated. This is allowed
+             * for the `'ECDH'`, `'X25519'`, and `'X448'` algorithms.
              * If successful, the returned promise will be resolved with an `<ArrayBuffer>` containing the generated data.
              *
              * The algorithms currently supported include:
@@ -3735,7 +3737,8 @@ declare module 'crypto' {
              * - `'PBKDF2'`
              * @since v15.0.0
              */
-            deriveBits(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>;
+            deriveBits(algorithm: EcdhKeyDeriveParams, baseKey: CryptoKey, length: number | null): Promise<ArrayBuffer>;
+            deriveBits(algorithm: AlgorithmIdentifier | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>;
             /**
              * Using the method and parameters specified in `algorithm`, and the keying material provided by `baseKey`,
              * `subtle.deriveKey()` attempts to generate a new <CryptoKey>` based on the method and parameters in `derivedKeyAlgorithm`.

node/ts4.8/fs/promises.d.ts

@@ -37,6 +37,7 @@ declare module 'fs/promises' {
         WriteStream,
         WriteVResult,
     } from 'node:fs';
+    import { Interface as ReadlineInterface } from 'node:readline';
 
     interface FileChangeInfo<T extends string | Buffer> {
         eventType: WatchEventType;
@@ -284,6 +285,23 @@ declare module 'fs/promises' {
                 | BufferEncoding
                 | null
         ): Promise<string | Buffer>;
+        /**
+         * Convenience method to create a `readline` interface and stream over the file. For example:
+         *
+         * ```js
+         * import { open } from 'node:fs/promises';
+         *
+         * const file = await open('./some/file/to/read');
+         *
+         * for await (const line of file.readLines()) {
+         *   console.log(line);
+         * }
+         * ```
+         *
+         * @since v18.11.0
+         * @param options See `filehandle.createReadStream()` for the options.
+         */
+        readLines(options?: CreateReadStreamOptions): ReadlineInterface;
         /**
          * @since v10.0.0
          * @return Fulfills with an {fs.Stats} for the file.

node/ts4.8/http.d.ts

@@ -570,11 +570,46 @@ declare module 'http' {
         assignSocket(socket: Socket): void;
         detachSocket(socket: Socket): void;
         /**
-         * Sends a HTTP/1.1 100 Continue message to the client, indicating that
+         * Sends an HTTP/1.1 100 Continue message to the client, indicating that
          * the request body should be sent. See the `'checkContinue'` event on`Server`.
          * @since v0.3.0
          */
         writeContinue(callback?: () => void): void;
+        /**
+         * Sends an HTTP/1.1 103 Early Hints message to the client with a Link header,
+         * indicating that the user agent can preload/preconnect the linked resources.
+         * The `hints` is an object containing the values of headers to be sent with
+         * early hints message. The optional `callback` argument will be called when
+         * the response message has been written.
+         *
+         * Example:
+         *
+         * ```js
+         * const earlyHintsLink = '</styles.css>; rel=preload; as=style';
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLink,
+         * });
+         *
+         * const earlyHintsLinks = [
+         *   '</styles.css>; rel=preload; as=style',
+         *   '</scripts.js>; rel=preload; as=script',
+         * ];
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks,
+         *   'x-trace-id': 'id for diagnostics'
+         * });
+         *
+         * const earlyHintsCallback = () => console.log('early hints message sent');
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks
+         * }, earlyHintsCallback);
+         * ```
+         *
+         * @since v18.11.0
+         * @param hints An object containing the values of headers
+         * @param callback Will be called when the response message has been written
+         */
+        writeEarlyHints(hints: Record<string, string | string[]>, callback?: () => void): void;
         /**
          * Sends a response header to the request. The status code is a 3-digit HTTP
          * status code, like `404`. The last argument, `headers`, are the response headers.
@@ -639,7 +674,7 @@ declare module 'http' {
         ): this;
         writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this;
         /**
-         * Sends a HTTP/1.1 102 Processing message to the client, indicating that
+         * Sends an HTTP/1.1 102 Processing message to the client, indicating that
          * the request body should be sent.
          * @since v10.0.0
          */

node/ts4.8/http2.d.ts

@@ -1670,6 +1670,34 @@ declare module 'http2' {
          * @since v8.4.0
          */
         writeContinue(): void;
+        /**
+         * Sends a status `103 Early Hints` to the client with a Link header,
+         * indicating that the user agent can preload/preconnect the linked resources.
+         * The `hints` is an object containing the values of headers to be sent with
+         * early hints message.
+         *
+         * Example:
+         *
+         * ```js
+         * const earlyHintsLink = '</styles.css>; rel=preload; as=style';
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLink,
+         * });
+         *
+         * const earlyHintsLinks = [
+         *   '</styles.css>; rel=preload; as=style',
+         *   '</scripts.js>; rel=preload; as=script',
+         * ];
+         * response.writeEarlyHints({
+         *   'link': earlyHintsLinks,
+         *   'x-trace-id': 'id for diagnostics'
+         * });
+         * ```
+         *
+         * @since v18.11.0
+         * @param hints An object containing the values of headers
+         */
+        writeEarlyHints(hints: Record<string, string | string[]>): void;
         /**
          * Sends a response header to the request. The status code is a 3-digit HTTP
          * status code, like `404`. The last argument, `headers`, are the response headers.

node/ts4.8/path.d.ts

@@ -122,10 +122,10 @@ declare module 'path' {
              * Often used to extract the file name from a fully qualified path.
              *
              * @param path the path to evaluate.
-             * @param ext optionally, an extension to remove from the result.
+             * @param suffix optionally, an extension to remove from the result.
              * @throws {TypeError} if `path` is not a string or if `ext` is given and is not a string.
              */
-            basename(path: string, ext?: string): string;
+            basename(path: string, suffix?: string): string;
             /**
              * Return the extension of the path, from the last '.' to end of string in the last portion of the path.
              * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.

node/ts4.8/stream.d.ts

@@ -18,7 +18,7 @@
  */
 declare module 'stream' {
     import { EventEmitter, Abortable } from 'node:events';
-    import { Blob } from "node:buffer";
+    import { Blob as NodeBlob } from "node:buffer";
     import * as streamPromises from 'node:stream/promises';
     import * as streamConsumers from 'node:stream/consumers';
     import * as streamWeb from 'node:stream/web';
@@ -893,7 +893,7 @@ declare module 'stream' {
              *
              * @since v16.8.0
              */
-            static from(src: Stream | Blob | ArrayBuffer | string | Iterable<any> | AsyncIterable<any> | AsyncGeneratorFunction | Promise<any> | Object): Duplex;
+            static from(src: Stream | NodeBlob | ArrayBuffer | string | Iterable<any> | AsyncIterable<any> | AsyncGeneratorFunction | Promise<any> | Object): Duplex;
             _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
             _writev?(
                 chunks: Array<{

node/ts4.8/util.d.ts

@@ -162,6 +162,27 @@ declare module 'util' {
      * @since v16.8.0, v14.18.0
      */
     export function toUSVString(string: string): string;
+    /**
+     * Creates and returns an `AbortController` instance whose `AbortSignal` is marked
+     * as transferable and can be used with `structuredClone()` or `postMessage()`.
+     * @since v18.11.0
+     * @returns A transferable AbortController
+     */
+    export function transferableAbortController(): AbortController;
+    /**
+     * Marks the given {AbortSignal} as transferable so that it can be used with
+     * `structuredClone()` and `postMessage()`.
+     *
+     * ```js
+     * const signal = transferableAbortSignal(AbortSignal.timeout(100));
+     * const channel = new MessageChannel();
+     * channel.port2.postMessage(signal, [signal]);
+     * ```
+     * @since v18.11.0
+     * @param signal The AbortSignal
+     * @returns The same AbortSignal
+     */
+    export function transferableAbortSignal(signal: AbortSignal): AbortSignal;
     /**
      * The `util.inspect()` method returns a string representation of `object` that is
      * intended for debugging. The output of `util.inspect` may change at any time
@@ -1155,6 +1176,9 @@ declare module 'util' {
      *       times. If `true`, all values will be collected in an array. If
      *       `false`, values for the option are last-wins. **Default:** `false`.
      *     - `short` A single character alias for the option.
+     *     - `default` The default option value when it is not set by args. It
+     *       must be of the same type as the `type` property. When `multiple`
+     *       is `true`, it must be an array.
      *
      *   - `strict`: Whether an error should be thrown when unknown arguments
      *     are encountered, or when arguments are passed that do not match the
@@ -1180,6 +1204,10 @@ declare module 'util' {
         type: 'string' | 'boolean';
         short?: string;
         multiple?: boolean;
+        /**
+         * @since v18.11.0
+         */
+        default?: string | boolean | string[] | boolean[];
     }
 
     interface ParseArgsOptionsConfig {

node/util.d.ts

@@ -162,6 +162,27 @@ declare module 'util' {
      * @since v16.8.0, v14.18.0
      */
     export function toUSVString(string: string): string;
+    /**
+     * Creates and returns an `AbortController` instance whose `AbortSignal` is marked
+     * as transferable and can be used with `structuredClone()` or `postMessage()`.
+     * @since v18.11.0
+     * @returns A transferable AbortController
+     */
+    export function transferableAbortController(): AbortController;
+    /**
+     * Marks the given {AbortSignal} as transferable so that it can be used with
+     * `structuredClone()` and `postMessage()`.
+     *
+     * ```js
+     * const signal = transferableAbortSignal(AbortSignal.timeout(100));
+     * const channel = new MessageChannel();
+     * channel.port2.postMessage(signal, [signal]);
+     * ```
+     * @since v18.11.0
+     * @param signal The AbortSignal
+     * @returns The same AbortSignal
+     */
+    export function transferableAbortSignal(signal: AbortSignal): AbortSignal;
     /**
      * The `util.inspect()` method returns a string representation of `object` that is
      * intended for debugging. The output of `util.inspect` may change at any time
@@ -1155,6 +1176,9 @@ declare module 'util' {
      *       times. If `true`, all values will be collected in an array. If
      *       `false`, values for the option are last-wins. **Default:** `false`.
      *     - `short` A single character alias for the option.
+     *     - `default` The default option value when it is not set by args. It
+     *       must be of the same type as the `type` property. When `multiple`
+     *       is `true`, it must be an array.
      *
      *   - `strict`: Whether an error should be thrown when unknown arguments
      *     are encountered, or when arguments are passed that do not match the
@@ -1180,6 +1204,10 @@ declare module 'util' {
         type: 'string' | 'boolean';
         short?: string;
         multiple?: boolean;
+        /**
+         * @since v18.11.0
+         */
+        default?: string | boolean | string[] | boolean[];
     }
 
     interface ParseArgsOptionsConfig {