@types/node 18.16.20 → 18.17.1

{node v18.16 → node v18.17}/test.d.ts

@@ -58,7 +58,10 @@ declare module 'node:test' {
             it,
             run,
             mock,
-            test
+            test,
+            skip,
+            todo,
+            only
         };
     }
     /**
@@ -129,6 +132,30 @@ declare module 'node:test' {
         function only(options?: TestOptions, fn?: TestFn): void;
         function only(fn?: TestFn): void;
     }
+    /**
+     * Shorthand for skipping a test, same as `test([name], { skip: true }[, fn])`.
+     * @since v18.17.0
+     */
+    function skip(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
+    function skip(name?: string, fn?: TestFn): Promise<void>;
+    function skip(options?: TestOptions, fn?: TestFn): Promise<void>;
+    function skip(fn?: TestFn): Promise<void>;
+    /**
+     * Shorthand for marking a test as `TODO`, same as `test([name], { todo: true }[, fn])`.
+     * @since v18.17.0
+     */
+    function todo(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
+    function todo(name?: string, fn?: TestFn): Promise<void>;
+    function todo(options?: TestOptions, fn?: TestFn): Promise<void>;
+    function todo(fn?: TestFn): Promise<void>;
+    /**
+     * Shorthand for marking a test as `only`, same as `test([name], { only: true }[, fn])`.
+     * @since v18.17.0
+     */
+    function only(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
+    function only(name?: string, fn?: TestFn): Promise<void>;
+    function only(options?: TestOptions, fn?: TestFn): Promise<void>;
+    function only(fn?: TestFn): Promise<void>;
 
     /**
      * The type of a function under test. The first argument to this function is a
@@ -192,160 +219,66 @@ declare module 'node:test' {
         addListener(event: 'test:pass', listener: (data: TestPass) => void): this;
         addListener(event: 'test:plan', listener: (data: TestPlan) => void): this;
         addListener(event: 'test:start', listener: (data: TestStart) => void): this;
+        addListener(event: 'test:stderr', listener: (data: TestStderr) => void): this;
+        addListener(event: 'test:stdout', listener: (data: TestStdout) => void): this;
         addListener(event: string, listener: (...args: any[]) => void): this;
         emit(event: 'test:diagnostic', data: DiagnosticData): boolean;
         emit(event: 'test:fail', data: TestFail): boolean;
         emit(event: 'test:pass', data: TestPass): boolean;
         emit(event: 'test:plan', data: TestPlan): boolean;
         emit(event: 'test:start', data: TestStart): boolean;
+        emit(event: 'test:stderr', data: TestStderr): boolean;
+        emit(event: 'test:stdout', data: TestStdout): boolean;
         emit(event: string | symbol, ...args: any[]): boolean;
         on(event: 'test:diagnostic', listener: (data: DiagnosticData) => void): this;
         on(event: 'test:fail', listener: (data: TestFail) => void): this;
         on(event: 'test:pass', listener: (data: TestPass) => void): this;
         on(event: 'test:plan', listener: (data: TestPlan) => void): this;
         on(event: 'test:start', listener: (data: TestStart) => void): this;
+        on(event: 'test:stderr', listener: (data: TestStderr) => void): this;
+        on(event: 'test:stdout', listener: (data: TestStdout) => void): this;
         on(event: string, listener: (...args: any[]) => void): this;
         once(event: 'test:diagnostic', listener: (data: DiagnosticData) => void): this;
         once(event: 'test:fail', listener: (data: TestFail) => void): this;
         once(event: 'test:pass', listener: (data: TestPass) => void): this;
         once(event: 'test:plan', listener: (data: TestPlan) => void): this;
         once(event: 'test:start', listener: (data: TestStart) => void): this;
+        once(event: 'test:stderr', listener: (data: TestStderr) => void): this;
+        once(event: 'test:stdout', listener: (data: TestStdout) => void): this;
         once(event: string, listener: (...args: any[]) => void): this;
         prependListener(event: 'test:diagnostic', listener: (data: DiagnosticData) => void): this;
         prependListener(event: 'test:fail', listener: (data: TestFail) => void): this;
         prependListener(event: 'test:pass', listener: (data: TestPass) => void): this;
         prependListener(event: 'test:plan', listener: (data: TestPlan) => void): this;
         prependListener(event: 'test:start', listener: (data: TestStart) => void): this;
+        prependListener(event: 'test:stderr', listener: (data: TestStderr) => void): this;
+        prependListener(event: 'test:stdout', listener: (data: TestStdout) => void): this;
         prependListener(event: string, listener: (...args: any[]) => void): this;
         prependOnceListener(event: 'test:diagnostic', listener: (data: DiagnosticData) => void): this;
         prependOnceListener(event: 'test:fail', listener: (data: TestFail) => void): this;
         prependOnceListener(event: 'test:pass', listener: (data: TestPass) => void): this;
         prependOnceListener(event: 'test:plan', listener: (data: TestPlan) => void): this;
         prependOnceListener(event: 'test:start', listener: (data: TestStart) => void): this;
+        prependOnceListener(event: 'test:stderr', listener: (data: TestStderr) => void): this;
+        prependOnceListener(event: 'test:stdout', listener: (data: TestStdout) => void): this;
         prependOnceListener(event: string, listener: (...args: any[]) => void): this;
     }
 
-    interface DiagnosticData {
-        /**
-         * The diagnostic message.
-         */
-        message: string;
-
-        /**
-         * The nesting level of the test.
-         */
-        nesting: number;
-    }
-
-    interface TestFail {
-        /**
-         * Additional execution metadata.
-         */
-        details: {
-            /**
-             * The duration of the test in milliseconds.
-             */
-            duration: number;
-
-            /**
-             * The error thrown by the test.
-             */
-            error: Error;
-        };
-
-        /**
-         * The test name.
-         */
-        name: string;
-
-        /**
-         * The nesting level of the test.
-         */
-        nesting: number;
-
-        /**
-         * The ordinal number of the test.
-         */
-        testNumber: number;
-
-        /**
-         * Present if `context.todo` is called.
-         */
-        todo?: string | boolean;
-
-        /**
-         * Present if `context.skip` is called.
-         */
-        skip?: string | boolean;
-    }
-
-    interface TestPass {
-        /**
-         * Additional execution metadata.
-         */
-        details: {
-            /**
-             * The duration of the test in milliseconds.
-             */
-            duration: number;
-        };
-
-        /**
-         * The test name.
-         */
-        name: string;
-
-        /**
-         * The nesting level of the test.
-         */
-        nesting: number;
-
-        /**
-         * The ordinal number of the test.
-         */
-        testNumber: number;
-
-        /**
-         * Present if `context.todo` is called.
-         */
-        todo?: string | boolean;
-
-        /**
-         * Present if `context.skip` is called.
-         */
-        skip?: string | boolean;
-    }
-
-    interface TestPlan {
-        /**
-         * The nesting level of the test.
-         */
-        nesting: number;
-
-        /**
-         * The number of subtests that have ran.
-         */
-        count: number;
-    }
-
-    interface TestStart {
-        /**
-         * The test name.
-         */
-        name: string;
-
-        /**
-         * The nesting level of the test.
-         */
-        nesting: number;
-    }
-
     /**
      * An instance of `TestContext` is passed to each test function in order to interact with the
      * test runner. However, the `TestContext` constructor is not exposed as part of the API.
      * @since v18.0.0
      */
     interface TestContext {
+        /**
+         * This function is used to create a hook running before subtest of the current test.
+         * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
+         *    the second argument. Default: A no-op function.
+         * @param options Configuration options for the hook.
+         * @since v18.17.0
+         */
+        before: typeof before;
+
         /**
          * This function is used to create a hook running before each subtest of the current test.
          * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
@@ -781,3 +714,189 @@ declare module 'node:test' {
 
     export { test as default, run, test, describe, it, before, after, beforeEach, afterEach, mock };
 }
+
+interface DiagnosticData {
+    /**
+     * The diagnostic message.
+     */
+    message: string;
+    /**
+     * The nesting level of the test.
+     */
+    nesting: number;
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+}
+interface TestFail {
+    /**
+     * Additional execution metadata.
+     */
+    details: {
+        /**
+         * The duration of the test in milliseconds.
+         */
+        duration: number;
+        /**
+         * The error thrown by the test.
+         */
+        error: Error;
+    };
+    /**
+     * The test name.
+     */
+    name: string;
+    /**
+     * The nesting level of the test.
+     */
+    nesting: number;
+    /**
+     * The ordinal number of the test.
+     */
+    testNumber: number;
+    /**
+     * Present if `context.todo` is called.
+     */
+    todo?: string | boolean;
+    /**
+     * Present if `context.skip` is called.
+     */
+    skip?: string | boolean;
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+}
+interface TestPass {
+    /**
+     * Additional execution metadata.
+     */
+    details: {
+        /**
+         * The duration of the test in milliseconds.
+         */
+        duration: number;
+    };
+    /**
+     * The test name.
+     */
+    name: string;
+    /**
+     * The nesting level of the test.
+     */
+    nesting: number;
+    /**
+     * The ordinal number of the test.
+     */
+    testNumber: number;
+    /**
+     * Present if `context.todo` is called.
+     */
+    todo?: string | boolean;
+    /**
+     * Present if `context.skip` is called.
+     */
+    skip?: string | boolean;
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+}
+interface TestPlan {
+    /**
+     * The nesting level of the test.
+     */
+    nesting: number;
+    /**
+     * The number of subtests that have ran.
+     */
+    count: number;
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+}
+interface TestStart {
+    /**
+     * The test name.
+     */
+    name: string;
+    /**
+     * The nesting level of the test.
+     */
+    nesting: number;
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+}
+interface TestStderr {
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+    /**
+     * The message written to `stderr`
+     */
+    message: string;
+}
+interface TestStdout {
+    /**
+     * The path of the test file, undefined if test is not ran through a file.
+     */
+    file?: string;
+    /**
+     * The message written to `stdout`
+     */
+    message: string;
+}
+
+/**
+ * The `node:test/reporters` module exposes the builtin-reporters for `node:test`.
+ * To access it:
+ *
+ * ```js
+ * import test from 'node:test/reporters';
+ * ```
+ *
+ * This module is only available under the `node:` scheme. The following will not
+ * work:
+ *
+ * ```js
+ * import test from 'test/reporters';
+ * ```
+ * @since v18.17.0
+ * @see [source](https://github.com/nodejs/node/blob/v18.17.0/lib/test/reporters.js)
+ */
+declare module 'node:test/reporters' {
+    import { Transform } from 'node:stream';
+
+    type TestEvent =
+        | { type: 'test:diagnostic', data: DiagnosticData }
+        | { type: 'test:fail', data: TestFail }
+        | { type: 'test:pass', data: TestPass }
+        | { type: 'test:plan', data: TestPlan }
+        | { type: 'test:start', data: TestStart }
+        | { type: 'test:stderr', data: TestStderr }
+        | { type: 'test:stdout', data: TestStdout };
+    type TestEventGenerator = AsyncGenerator<TestEvent, void>;
+
+    /**
+     * 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`.
+     */
+    function dot(source: TestEventGenerator): AsyncGenerator<'\n' | '.' | 'X', void>;
+    /**
+     * The `tap` reporter outputs the test results in the [TAP](https://testanything.org/) format.
+     */
+    function tap(source: TestEventGenerator): AsyncGenerator<string, void>;
+    /**
+     * The `spec` reporter outputs the test results in a human-readable format.
+     */
+    class Spec extends Transform {
+        constructor();
+    }
+    export { dot, tap, Spec as spec };
+}

{node v18.16 → node v18.17/ts4.8}/dns.d.ts

@@ -484,6 +484,14 @@ declare module 'dns' {
      * @since v0.1.16
      */
     export function reverse(ip: string, callback: (err: NodeJS.ErrnoException | null, hostnames: string[]) => void): void;
+    /**
+     * Get the default value for `verbatim` in {@link lookup} and `dnsPromises.lookup()`. The value could be:
+     *
+     * * `ipv4first`: for `verbatim` defaulting to `false`.
+     * * `verbatim`: for `verbatim` defaulting to `true`.
+     * @since v18.17.0
+     */
+    export function getDefaultResultOrder(): 'ipv4first' | 'verbatim';
     /**
      * Sets the IP address and port of servers to be used when performing DNS
      * resolution. The `servers` argument is an array of [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6) formatted

{node v18.16 → node v18.17}/ts4.8/events.d.ts

@@ -297,6 +297,35 @@ declare module 'events' {
          * @since v15.2.0, v14.17.0
          */
         static getEventListeners(emitter: _DOMEventTarget | NodeJS.EventEmitter, name: string | symbol): Function[];
+        /**
+         * Returns the currently set max amount of listeners.
+         *
+         * For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on
+         * the emitter.
+         *
+         * For `EventTarget`s this is the only way to get the max event listeners for the
+         * event target. If the number of event handlers on a single EventTarget exceeds
+         * the max set, the EventTarget will print a warning.
+         *
+         * ```js
+         * import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
+         *
+         * {
+         *   const ee = new EventEmitter();
+         *   console.log(getMaxListeners(ee)); // 10
+         *   setMaxListeners(11, ee);
+         *   console.log(getMaxListeners(ee)); // 11
+         * }
+         * {
+         *   const et = new EventTarget();
+         *   console.log(getMaxListeners(et)); // 10
+         *   setMaxListeners(11, et);
+         *   console.log(getMaxListeners(et)); // 11
+         * }
+         * ```
+         * @since v18.17.0
+         */
+        static getMaxListeners(emitter: _DOMEventTarget | NodeJS.EventEmitter): number;
         /**
          * ```js
          * const {

{node v18.16 → node v18.17}/ts4.8/fs/promises.d.ts

@@ -14,6 +14,7 @@ declare module 'fs/promises' {
     import { ReadableStream } from 'node:stream/web';
     import {
         BigIntStats,
+        BigIntStatsFs,
         BufferEncodingOption,
         constants as fsConstants,
         CopyOptions,
@@ -30,7 +31,9 @@ declare module 'fs/promises' {
         RmDirOptions,
         RmOptions,
         StatOptions,
+        StatFsOptions,
         Stats,
+        StatsFs,
         TimeLike,
         WatchEventType,
         WatchOptions,
@@ -80,6 +83,13 @@ declare module 'fs/promises' {
         emitClose?: boolean | undefined;
         start?: number | undefined;
     }
+    interface ReadableWebStreamOptions {
+        /**
+         * Whether to open a normal or a `'bytes'` stream.
+         * @since v18.17.0
+         */
+        type?: 'bytes' | undefined;
+    }
     // TODO: Add `EventEmitter` close
     interface FileHandle {
         /**
@@ -236,7 +246,7 @@ declare module 'fs/promises' {
          * @since v17.0.0
          * @experimental
          */
-        readableWebStream(): ReadableStream;
+        readableWebStream(options?: ReadableWebStreamOptions): ReadableStream;
         /**
          * Asynchronously reads the entire contents of a file.
          *
@@ -630,6 +640,7 @@ declare module 'fs/promises' {
         options?:
             | (ObjectEncodingOptions & {
                   withFileTypes?: false | undefined;
+                  recursive?: boolean | undefined;
               })
             | BufferEncoding
             | null
@@ -645,6 +656,7 @@ declare module 'fs/promises' {
             | {
                   encoding: 'buffer';
                   withFileTypes?: false | undefined;
+                  recursive?: boolean | undefined;
               }
             | 'buffer'
     ): Promise<Buffer[]>;
@@ -658,6 +670,7 @@ declare module 'fs/promises' {
         options?:
             | (ObjectEncodingOptions & {
                   withFileTypes?: false | undefined;
+                  recursive?: boolean | undefined;
               })
             | BufferEncoding
             | null
@@ -671,6 +684,7 @@ declare module 'fs/promises' {
         path: PathLike,
         options: ObjectEncodingOptions & {
             withFileTypes: true;
+            recursive?: boolean | undefined;
         }
     ): Promise<Dirent[]>;
     /**
@@ -745,6 +759,24 @@ declare module 'fs/promises' {
         }
     ): Promise<BigIntStats>;
     function stat(path: PathLike, opts?: StatOptions): Promise<Stats | BigIntStats>;
+    /**
+     * @since v18.15.0
+     * @return Fulfills with an {fs.StatFs} for the file system.
+     */
+    function statfs(
+        path: PathLike,
+        opts?: StatFsOptions & {
+            bigint?: false | undefined;
+        }
+    ): Promise<StatsFs>;
+    function statfs(
+        path: PathLike,
+        opts: StatFsOptions & {
+            bigint: true;
+        }
+    ): Promise<BigIntStatsFs>;
+    function statfs(path: PathLike, opts?: StatFsOptions): Promise<StatsFs | BigIntStatsFs>;
+
     /**
      * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail.
      * @since v10.0.0