@types/node 22.3.0 → 22.4.1

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Wed, 14 Aug 2024 07:35:57 GMT
+ * Last updated: Mon, 19 Aug 2024 02:45:10 GMT
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
 
 # Credits

node/globals.d.ts

@@ -103,6 +103,84 @@ declare global {
         };
     // #endregion borrowed
 
+    // #region Storage
+    /**
+     * This Web Storage API interface provides access to a particular domain's session or local storage. It allows, for example, the addition, modification, or deletion of stored data items.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage)
+     */
+    interface Storage {
+        /**
+         * Returns the number of key/value pairs.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/length)
+         */
+        readonly length: number;
+        /**
+         * Removes all key/value pairs, if there are any.
+         *
+         * Dispatches a storage event on Window objects holding an equivalent Storage object.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/clear)
+         */
+        clear(): void;
+        /**
+         * Returns the current value associated with the given key, or null if the given key does not exist.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/getItem)
+         */
+        getItem(key: string): string | null;
+        /**
+         * Returns the name of the nth key, or null if n is greater than or equal to the number of key/value pairs.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/key)
+         */
+        key(index: number): string | null;
+        /**
+         * Removes the key/value pair with the given key, if a key/value pair with the given key exists.
+         *
+         * Dispatches a storage event on Window objects holding an equivalent Storage object.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/removeItem)
+         */
+        removeItem(key: string): void;
+        /**
+         * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+         *
+         * Throws a "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)
+         *
+         * Dispatches a storage event on Window objects holding an equivalent Storage object.
+         *
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/setItem)
+         */
+        setItem(key: string, value: string): void;
+    }
+
+    var Storage: typeof globalThis extends { onmessage: any; Storage: infer T } ? T
+        : {
+            prototype: Storage;
+            new(): Storage;
+        };
+
+    /**
+     * A browser-compatible implementation of [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
+     * Data is stored unencrypted in the file specified by the `--localstorage-file` CLI flag.
+     * Any modification of this data outside of the Web Storage API is not supported.
+     * Enable this API with the `--experimental-webstorage` CLI flag.
+     * @since v22.4.0
+     */
+    var localStorage: Storage;
+
+    /**
+     * A browser-compatible implementation of [`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
+     * Data is stored in memory, with a storage quota of 10 MB.
+     * Any modification of this data outside of the Web Storage API is not supported.
+     * Enable this API with the `--experimental-webstorage` CLI flag.
+     * @since v22.4.0
+     */
+    var sessionStorage: Storage;
+    // #endregion Storage
+
     // #region Disposable
     interface SymbolConstructor {
         /**

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "22.3.0",
+    "version": "22.4.1",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -210,8 +210,8 @@
     },
     "scripts": {},
     "dependencies": {
-        "undici-types": "~6.18.2"
+        "undici-types": "~6.19.2"
     },
-    "typesPublisherContentHash": "620b8a407d4118e9931ab6e01ed7af87ce13d63daa46a4098fca6d43eaf853db",
+    "typesPublisherContentHash": "ccc9f99822466307487be499b4c3c04a1a5f42f97b354a1afa5584dfa95e982d",
     "typeScriptVersion": "4.8"
 }

node/process.d.ts

@@ -322,24 +322,28 @@ declare module "process" {
                 has(scope: string, reference?: string): boolean;
             }
             interface ProcessReport {
+                /**
+                 * Write reports in a compact format, single-line JSON, more easily consumable by log processing systems
+                 * than the default multi-line format designed for human consumption.
+                 * @since v13.12.0, v12.17.0
+                 */
+                compact: boolean;
                 /**
                  * Directory where the report is written.
+                 * The default value is the empty string, indicating that reports are written to the current
                  * working directory of the Node.js process.
-                 * @default '' indicating that reports are written to the current
                  */
                 directory: string;
                 /**
-                 * Filename where the report is written.
-                 * The default value is the empty string.
-                 * @default '' the output filename will be comprised of a timestamp,
-                 * PID, and sequence number.
+                 * Filename where the report is written. If set to the empty string, the output filename will be comprised
+                 * of a timestamp, PID, and sequence number. The default value is the empty string.
                  */
                 filename: string;
                 /**
-                 * Returns a JSON-formatted diagnostic report for the running process.
-                 * The report's JavaScript stack trace is taken from err, if present.
+                 * Returns a JavaScript Object representation of a diagnostic report for the running process.
+                 * The report's JavaScript stack trace is taken from `err`, if present.
                  */
-                getReport(err?: Error): string;
+                getReport(err?: Error): object;
                 /**
                  * If true, a diagnostic report is generated on fatal errors,
                  * such as out of memory errors or failed C++ assertions.
@@ -365,18 +369,19 @@ declare module "process" {
                 /**
                  * Writes a diagnostic report to a file. If filename is not provided, the default filename
                  * includes the date, time, PID, and a sequence number.
-                 * The report's JavaScript stack trace is taken from err, if present.
+                 * The report's JavaScript stack trace is taken from `err`, if present.
                  *
+                 * If the value of filename is set to `'stdout'` or `'stderr'`, the report is written
+                 * to the stdout or stderr of the process respectively.
                  * @param fileName Name of the file where the report is written.
                  * This should be a relative path, that will be appended to the directory specified in
                  * `process.report.directory`, or the current working directory of the Node.js process,
                  * if unspecified.
-                 * @param error A custom error used for reporting the JavaScript stack.
+                 * @param err A custom error used for reporting the JavaScript stack.
                  * @return Filename of the generated report.
                  */
-                writeReport(fileName?: string): string;
-                writeReport(error?: Error): string;
                 writeReport(fileName?: string, err?: Error): string;
+                writeReport(err?: Error): string;
             }
             interface ResourceUsage {
                 fsRead: number;
@@ -1704,11 +1709,11 @@ declare module "process" {
                  */
                 allowedNodeEnvironmentFlags: ReadonlySet<string>;
                 /**
-                 * `process.report` is an object whose methods are used to generate diagnostic
-                 * reports for the current process. Additional documentation is available in the `report documentation`.
+                 * `process.report` is an object whose methods are used to generate diagnostic reports for the current process.
+                 * Additional documentation is available in the [report documentation](https://nodejs.org/docs/latest-v22.x/api/report.html).
                  * @since v11.8.0
                  */
-                report?: ProcessReport | undefined;
+                report: ProcessReport;
                 /**
                  * ```js
                  * import { resourceUsage } from 'node:process';

node/test.d.ts

@@ -1960,31 +1960,47 @@ declare module "node:test/reporters" {
         | { type: "test:watch:drained"; data: undefined };
     type TestEventGenerator = AsyncGenerator<TestEvent, void>;
 
+    interface ReporterConstructorWrapper<T extends new(...args: any[]) => Transform> {
+        new(...args: ConstructorParameters<T>): InstanceType<T>;
+        (...args: ConstructorParameters<T>): InstanceType<T>;
+    }
+
     /**
      * The `dot` reporter outputs the test results in a compact format,
      * where each passing test is represented by a `.`,
      * and each failing test is represented by a `X`.
+     * @since v20.0.0
      */
     function dot(source: TestEventGenerator): AsyncGenerator<"\n" | "." | "X", void>;
     /**
      * The `tap` reporter outputs the test results in the [TAP](https://testanything.org/) format.
+     * @since v20.0.0
      */
     function tap(source: TestEventGenerator): AsyncGenerator<string, void>;
+    class SpecReporter extends Transform {
+        constructor();
+    }
     /**
      * The `spec` reporter outputs the test results in a human-readable format.
+     * @since v20.0.0
      */
-    class Spec extends Transform {
-        constructor();
-    }
+    const spec: ReporterConstructorWrapper<typeof SpecReporter>;
     /**
      * The `junit` reporter outputs test results in a jUnit XML format.
+     * @since v21.0.0
      */
     function junit(source: TestEventGenerator): AsyncGenerator<string, void>;
+    class LcovReporter extends Transform {
+        constructor(opts?: Omit<TransformOptions, "writableObjectMode">);
+    }
     /**
-     * The `lcov` reporter outputs test coverage when used with the [`--experimental-test-coverage`](https://nodejs.org/docs/latest-v22.x/api/cli.html#--experimental-test-coverage) flag.
+     * The `lcov` reporter outputs test coverage when used with the
+     * [`--experimental-test-coverage`](https://nodejs.org/docs/latest-v22.x/api/cli.html#--experimental-test-coverage) flag.
+     * @since v22.0.0
      */
-    class Lcov extends Transform {
-        constructor(opts?: TransformOptions);
-    }
-    export { dot, junit, Lcov as lcov, Spec as spec, tap, TestEvent };
+    // TODO: change the export to a wrapper function once node@0db38f0 is merged (breaking change)
+    // const lcov: ReporterConstructorWrapper<typeof LcovReporter>;
+    const lcov: LcovReporter;
+
+    export { dot, junit, lcov, spec, tap, TestEvent };
 }

node/tls.d.ts

@@ -843,6 +843,7 @@ declare module "tls" {
         ciphers?: string | undefined;
         /**
          * Name of an OpenSSL engine which can provide the client certificate.
+         * @deprecated
          */
         clientCertEngine?: string | undefined;
         /**
@@ -885,12 +886,14 @@ declare module "tls" {
         /**
          * Name of an OpenSSL engine to get private key from. Should be used
          * together with privateKeyIdentifier.
+         * @deprecated
          */
         privateKeyEngine?: string | undefined;
         /**
          * Identifier of a private key managed by an OpenSSL engine. Should be
          * used together with privateKeyEngine. Should not be set together with
          * key, because both options define a private key in different ways.
+         * @deprecated
          */
         privateKeyIdentifier?: string | undefined;
         /**

node/util.d.ts

@@ -1480,6 +1480,12 @@ declare module "util" {
          * Whether this command accepts positional arguments.
          */
         allowPositionals?: boolean | undefined;
+        /**
+         * If `true`, allows explicitly setting boolean options to `false` by prefixing the option name with `--no-`.
+         * @default false
+         * @since v22.4.0
+         */
+        allowNegative?: boolean | undefined;
         /**
          * Return the parsed tokens. This is useful for extending the built-in behavior,
          * from adding additional checks through to reprocessing the tokens in different ways.