@types/node 16.11.39 → 18.11.2

node v16.11/perf_hooks.d.ts → node/perf_hooks.d.ts

@@ -26,7 +26,7 @@
  *   performance.measure('A to B', 'A', 'B');
  * });
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/perf_hooks.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/perf_hooks.js)
  */
 declare module 'perf_hooks' {
     import { AsyncResource } from 'node:async_hooks';
@@ -85,6 +85,14 @@ declare module 'perf_hooks' {
          * @since v16.0.0
          */
         readonly detail?: NodeGCPerformanceDetail | unknown | undefined; // TODO: Narrow this based on entry type.
+        toJSON(): any;
+    }
+    class PerformanceMark extends PerformanceEntry {
+        readonly duration: 0;
+        readonly entryType: 'mark';
+    }
+    class PerformanceMeasure extends PerformanceEntry {
+        readonly entryType: 'measure';
     }
     /**
      * _This property is an extension by Node.js. It is not available in Web browsers._
@@ -191,14 +199,44 @@ declare module 'perf_hooks' {
          * @param name
          */
         clearMarks(name?: string): void;
+        /**
+         * If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline.
+         * If name is provided, removes only the named measure.
+         * @param name
+         * @since v16.7.0
+         */
+        clearMeasures(name?: string): void;
+        /**
+         * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`.
+         * If you are only interested in performance entries of certain types or that have certain names, see
+         * `performance.getEntriesByType()` and `performance.getEntriesByName()`.
+         * @since v16.7.0
+         */
+        getEntries(): PerformanceEntry[];
+        /**
+         * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
+         * whose `performanceEntry.name` is equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to `type`.
+         * @param name
+         * @param type
+         * @since v16.7.0
+         */
+        getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
+        /**
+         * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
+         * whose `performanceEntry.entryType` is equal to `type`.
+         * @param type
+         * @since v16.7.0
+         */
+        getEntriesByType(type: EntryType): PerformanceEntry[];
         /**
          * Creates a new PerformanceMark entry in the Performance Timeline.
          * A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark',
          * and whose performanceEntry.duration is always 0.
          * Performance marks are used to mark specific significant moments in the Performance Timeline.
          * @param name
+         * @return The PerformanceMark entry that was created
          */
-        mark(name?: string, options?: MarkOptions): void;
+        mark(name?: string, options?: MarkOptions): PerformanceMark;
         /**
          * Creates a new PerformanceMeasure entry in the Performance Timeline.
          * A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure',
@@ -213,9 +251,10 @@ declare module 'perf_hooks' {
          * @param name
          * @param startMark
          * @param endMark
+         * @return The PerformanceMeasure entry that was created
          */
-        measure(name: string, startMark?: string, endMark?: string): void;
-        measure(name: string, options: MeasureOptions): void;
+        measure(name: string, startMark?: string, endMark?: string): PerformanceMeasure;
+        measure(name: string, options: MeasureOptions): PerformanceMeasure;
         /**
          * An instance of the PerformanceNodeTiming class that provides performance metrics for specific Node.js operational milestones.
          */
@@ -270,6 +309,9 @@ declare module 'perf_hooks' {
          *    *   }
          *    * ]
          *
+         *
+         *   performance.clearMarks();
+         *   performance.clearMeasures();
          *   observer.disconnect();
          * });
          * obs.observe({ type: 'mark' });
@@ -317,6 +359,9 @@ declare module 'perf_hooks' {
          *    * ]
          *
          *   console.log(perfObserverList.getEntriesByName('test', 'measure')); // []
+         *
+         *   performance.clearMarks();
+         *   performance.clearMeasures();
          *   observer.disconnect();
          * });
          * obs.observe({ entryTypes: ['mark', 'measure'] });
@@ -355,6 +400,8 @@ declare module 'perf_hooks' {
          *    *   }
          *    * ]
          *
+         *   performance.clearMarks();
+         *   performance.clearMeasures();
          *   observer.disconnect();
          * });
          * obs.observe({ type: 'mark' });
@@ -384,7 +431,7 @@ declare module 'perf_hooks' {
          * } = require('perf_hooks');
          *
          * const obs = new PerformanceObserver((list, observer) => {
-         *   // Called three times synchronously. `list` contains one item.
+         *   // Called once asynchronously. `list` contains three items.
          * });
          * obs.observe({ type: 'mark' });
          *
@@ -487,7 +534,7 @@ declare module 'perf_hooks' {
     }
     interface RecordableHistogram extends Histogram {
         /**
-         * @since v15.9.0
+         * @since v15.9.0, v14.18.0
          * @param val The amount to record in the histogram.
          */
         record(val: number | bigint): void;
@@ -496,9 +543,15 @@ declare module 'perf_hooks' {
          * previous call to `recordDelta()` and records that amount in the histogram.
          *
          * ## Examples
-         * @since v15.9.0
+         * @since v15.9.0, v14.18.0
          */
         recordDelta(): void;
+        /**
+         * Adds the values from other to this histogram.
+         * @since v17.4.0, v16.14.0
+         * @param other Recordable Histogram to combine with
+         */
+         add(other: RecordableHistogram): void;
     }
     /**
      * _This property is an extension by Node.js. It is not available in Web browsers._
@@ -548,9 +601,24 @@ declare module 'perf_hooks' {
     }
     /**
      * Returns a `RecordableHistogram`.
-     * @since v15.9.0
+     * @since v15.9.0, v14.18.0
      */
     function createHistogram(options?: CreateHistogramOptions): RecordableHistogram;
+
+    import { performance as _performance } from 'perf_hooks';
+    global {
+        /**
+         * `performance` is a global reference for `require('perf_hooks').performance`
+         * https://nodejs.org/api/globals.html#performance
+         * @since v16.0.0
+         */
+        var performance: typeof globalThis extends {
+            onmessage: any;
+            performance: infer T;
+        }
+            ? T
+            : typeof _performance;
+    }
 }
 declare module 'node:perf_hooks' {
     export * from 'perf_hooks';

node v16.11/process.d.ts → node/process.d.ts

@@ -49,6 +49,7 @@ declare module 'process' {
                 openssl: string;
             }
             type Platform = 'aix' | 'android' | 'darwin' | 'freebsd' | 'haiku' | 'linux' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | 'netbsd';
+            type Architecture = 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x64';
             type Signals =
                 | 'SIGABRT'
                 | 'SIGALRM'
@@ -96,7 +97,7 @@ declare module 'process' {
             type UncaughtExceptionListener = (error: Error, origin: UncaughtExceptionOrigin) => void;
             /**
              * Most of the time the unhandledRejection will be an Error, but this should not be relied upon
-             * as *anything* can be thrown/rejected, it is therefore unsafe to assume the the value is an Error.
+             * as *anything* can be thrown/rejected, it is therefore unsafe to assume that the value is an Error.
              */
             type UnhandledRejectionListener = (reason: unknown, promise: Promise<unknown>) => void;
             type WarningListener = (warning: Error) => void;
@@ -589,7 +590,7 @@ declare module 'process' {
                  *
                  * The reason this is problematic is because writes to `process.stdout` in Node.js
                  * are sometimes _asynchronous_ and may occur over multiple ticks of the Node.js
-                 * event loop. Calling `process.exit()`, however, forces the process to exit_before_ those additional writes to `stdout` can be performed.
+                 * event loop. Calling `process.exit()`, however, forces the process to exit _before_ those additional writes to `stdout` can be performed.
                  *
                  * Rather than calling `process.exit()` directly, the code _should_ set the`process.exitCode` and allow the process to exit naturally by avoiding
                  * scheduling any additional work for the event loop:
@@ -641,7 +642,7 @@ declare module 'process' {
                  * Android).
                  * @since v0.1.31
                  */
-                getgid(): number;
+                getgid?: () => number;
                 /**
                  * The `process.setgid()` method sets the group identity of the process. (See [`setgid(2)`](http://man7.org/linux/man-pages/man2/setgid.2.html).) The `id` can be passed as either a
                  * numeric ID or a group name
@@ -668,7 +669,7 @@ declare module 'process' {
                  * @since v0.1.31
                  * @param id The group name or ID
                  */
-                setgid(id: number | string): void;
+                setgid?: (id: number | string) => void;
                 /**
                  * The `process.getuid()` method returns the numeric user identity of the process.
                  * (See [`getuid(2)`](http://man7.org/linux/man-pages/man2/getuid.2.html).)
@@ -685,7 +686,7 @@ declare module 'process' {
                  * Android).
                  * @since v0.1.28
                  */
-                getuid(): number;
+                getuid?: () => number;
                 /**
                  * The `process.setuid(id)` method sets the user identity of the process. (See [`setuid(2)`](http://man7.org/linux/man-pages/man2/setuid.2.html).) The `id` can be passed as either a
                  * numeric ID or a username string.
@@ -711,7 +712,7 @@ declare module 'process' {
                  * This feature is not available in `Worker` threads.
                  * @since v0.1.28
                  */
-                setuid(id: number | string): void;
+                setuid?: (id: number | string) => void;
                 /**
                  * The `process.geteuid()` method returns the numerical effective user identity of
                  * the process. (See [`geteuid(2)`](http://man7.org/linux/man-pages/man2/geteuid.2.html).)
@@ -728,7 +729,7 @@ declare module 'process' {
                  * Android).
                  * @since v2.0.0
                  */
-                geteuid(): number;
+                geteuid?: () => number;
                 /**
                  * The `process.seteuid()` method sets the effective user identity of the process.
                  * (See [`seteuid(2)`](http://man7.org/linux/man-pages/man2/seteuid.2.html).) The `id` can be passed as either a numeric ID or a username
@@ -755,7 +756,7 @@ declare module 'process' {
                  * @since v2.0.0
                  * @param id A user name or ID
                  */
-                seteuid(id: number | string): void;
+                seteuid?: (id: number | string) => void;
                 /**
                  * The `process.getegid()` method returns the numerical effective group identity
                  * of the Node.js process. (See [`getegid(2)`](http://man7.org/linux/man-pages/man2/getegid.2.html).)
@@ -772,7 +773,7 @@ declare module 'process' {
                  * Android).
                  * @since v2.0.0
                  */
-                getegid(): number;
+                getegid?: () => number;
                 /**
                  * The `process.setegid()` method sets the effective group identity of the process.
                  * (See [`setegid(2)`](http://man7.org/linux/man-pages/man2/setegid.2.html).) The `id` can be passed as either a numeric ID or a group
@@ -799,7 +800,7 @@ declare module 'process' {
                  * @since v2.0.0
                  * @param id A group name or ID
                  */
-                setegid(id: number | string): void;
+                setegid?: (id: number | string) => void;
                 /**
                  * The `process.getgroups()` method returns an array with the supplementary group
                  * IDs. POSIX leaves it unspecified if the effective group ID is included but
@@ -817,7 +818,7 @@ declare module 'process' {
                  * Android).
                  * @since v0.9.4
                  */
-                getgroups(): number[];
+                getgroups?: () => number[];
                 /**
                  * The `process.setgroups()` method sets the supplementary group IDs for the
                  * Node.js process. This is a privileged operation that requires the Node.js
@@ -843,7 +844,7 @@ declare module 'process' {
                  * This feature is not available in `Worker` threads.
                  * @since v0.9.4
                  */
-                setgroups(groups: ReadonlyArray<string | number>): void;
+                setgroups?: (groups: ReadonlyArray<string | number>) => void;
                 /**
                  * The `process.setUncaughtExceptionCaptureCallback()` function sets a function
                  * that will be invoked when an uncaught exception occurs, which will receive the
@@ -1040,7 +1041,7 @@ declare module 'process' {
                 title: string;
                 /**
                  * The operating system CPU architecture for which the Node.js binary was compiled.
-                 * Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,`'ppc64'`, `'s390'`, `'s390x'`, `'x32'`, and `'x64'`.
+                 * Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,`'ppc64'`, `'s390'`, `'s390x'`, and `'x64'`.
                  *
                  * ```js
                  * import { arch } from 'process';
@@ -1049,10 +1050,10 @@ declare module 'process' {
                  * ```
                  * @since v0.5.0
                  */
-                readonly arch: string;
+                readonly arch: Architecture;
                 /**
                  * The `process.platform` property returns a string identifying the operating
-                 * system platform on which the Node.js process is running.
+                 * system platform for which the Node.js binary was compiled.
                  *
                  * Currently possible values are:
                  *
@@ -1405,7 +1406,7 @@ declare module 'process' {
                 emit(event: 'unhandledRejection', reason: unknown, promise: Promise<unknown>): boolean;
                 emit(event: 'warning', warning: Error): boolean;
                 emit(event: 'message', message: unknown, sendHandle: unknown): this;
-                emit(event: Signals, signal: Signals): boolean;
+                emit(event: Signals, signal?: Signals): boolean;
                 emit(event: 'multipleResolves', type: MultipleResolveType, promise: Promise<unknown>, value: unknown): this;
                 emit(event: 'worker', listener: WorkerListener): this;
                 on(event: 'beforeExit', listener: BeforeExitListener): this;

node v16.11/punycode.d.ts → node/punycode.d.ts

@@ -24,7 +24,7 @@
  * made available to developers as a convenience. Fixes or other modifications to
  * the module must be directed to the [Punycode.js](https://github.com/bestiejs/punycode.js) project.
  * @deprecated Since v7.0.0 - Deprecated
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/punycode.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/punycode.js)
  */
 declare module 'punycode' {
     /**

node v16.11/querystring.d.ts → node/querystring.d.ts

@@ -6,10 +6,10 @@
  * const querystring = require('querystring');
  * ```
  *
- * The `querystring` API is considered Legacy. While it is still maintained,
- * new code should use the `URLSearchParams` API instead.
- * @deprecated Legacy
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/querystring.js)
+ * `querystring` is more performant than `URLSearchParams` but is not a
+ * standardized API. Use `URLSearchParams` when performance is not critical
+ * or when compatibility with browser code is desirable.
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/querystring.js)
  */
 declare module 'querystring' {
     interface StringifyOptions {

node/readline/promises.d.ts

@@ -0,0 +1,143 @@
+/**
+ * The `readline/promise` module provides an API for reading lines of input from a Readable stream one line at a time.
+ *
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline/promises.js)
+ * @since v17.0.0
+ */
+declare module 'readline/promises' {
+    import { Interface as _Interface, ReadLineOptions, Completer, AsyncCompleter, Direction } from 'node:readline';
+    import { Abortable } from 'node:events';
+
+    class Interface extends _Interface {
+        /**
+         * The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input,
+         * then invokes the callback function passing the provided input as the first argument.
+         *
+         * When called, rl.question() will resume the input stream if it has been paused.
+         *
+         * If the readlinePromises.Interface was created with output set to null or undefined the query is not written.
+         *
+         * If the question is called after rl.close(), it returns a rejected promise.
+         *
+         * Example usage:
+         *
+         * ```js
+         * const answer = await rl.question('What is your favorite food? ');
+         * console.log(`Oh, so your favorite food is ${answer}`);
+         * ```
+         *
+         * Using an AbortSignal to cancel a question.
+         *
+         * ```js
+         * const signal = AbortSignal.timeout(10_000);
+         *
+         * signal.addEventListener('abort', () => {
+         *   console.log('The food question timed out');
+         * }, { once: true });
+         *
+         * const answer = await rl.question('What is your favorite food? ', { signal });
+         * console.log(`Oh, so your favorite food is ${answer}`);
+         * ```
+         *
+         * @since v17.0.0
+         * @param query A statement or query to write to output, prepended to the prompt.
+         */
+        question(query: string): Promise<string>;
+        question(query: string, options: Abortable): Promise<string>;
+    }
+
+    class Readline {
+        /**
+         * @param stream A TTY stream.
+         */
+        constructor(stream: NodeJS.WritableStream, options?: { autoCommit?: boolean });
+        /**
+         * The `rl.clearLine()` method adds to the internal list of pending action an action that clears current line of the associated `stream` in a specified direction identified by `dir`.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
+         */
+        clearLine(dir: Direction): this;
+        /**
+         * The `rl.clearScreenDown()` method adds to the internal list of pending action an action that clears the associated `stream` from the current position of the cursor down.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
+         */
+        clearScreenDown(): this;
+        /**
+         * The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
+         */
+        commit(): Promise<void>;
+        /**
+         * The `rl.cursorTo()` method adds to the internal list of pending action an action that moves cursor to the specified position in the associated `stream`.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
+         */
+        cursorTo(x: number, y?: number): this;
+        /**
+         * The `rl.moveCursor()` method adds to the internal list of pending action an action that moves the cursor relative to its current position in the associated `stream`.
+         * Call `rl.commit()` to see the effect of this method, unless autoCommit: true was passed to the constructor.
+         */
+        moveCursor(dx: number, dy: number): this;
+        /**
+         * The `rl.rollback()` method clears the internal list of pending actions without sending it to the associated `stream`.
+         */
+        rollback(): this;
+    }
+
+    /**
+     * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
+     *
+     * ```js
+     * const readlinePromises = require('node:readline/promises');
+     * const rl = readlinePromises.createInterface({
+     *   input: process.stdin,
+     *   output: process.stdout
+     * });
+     * ```
+     *
+     * Once the `readlinePromises.Interface` instance is created, the most common case is to listen for the `'line'` event:
+     *
+     * ```js
+     * rl.on('line', (line) => {
+     *   console.log(`Received: ${line}`);
+     * });
+     * ```
+     *
+     * If `terminal` is `true` for this instance then the `output` stream will get the best compatibility if it defines an `output.columns` property,
+     * and emits a `'resize'` event on the `output`, if or when the columns ever change (`process.stdout` does this automatically when it is a TTY).
+     *
+     * ## Use of the `completer` function
+     *
+     * The `completer` function takes the current line entered by the user as an argument, and returns an `Array` with 2 entries:
+     *
+     * - An Array with matching entries for the completion.
+     * - The substring that was used for the matching.
+     *
+     * For instance: `[[substr1, substr2, ...], originalsubstring]`.
+     *
+     * ```js
+     * function completer(line) {
+     *   const completions = '.help .error .exit .quit .q'.split(' ');
+     *   const hits = completions.filter((c) => c.startsWith(line));
+     *   // Show all completions if none found
+     *   return [hits.length ? hits : completions, line];
+     * }
+     * ```
+     *
+     * The `completer` function can also returns a `Promise`, or be asynchronous:
+     *
+     * ```js
+     * async function completer(linePartial) {
+     *   await someAsyncWork();
+     *   return [['123'], linePartial];
+     * }
+     * ```
+     */
+    function createInterface(
+        input: NodeJS.ReadableStream,
+        output?: NodeJS.WritableStream,
+        completer?: Completer | AsyncCompleter,
+        terminal?: boolean,
+    ): Interface;
+    function createInterface(options: ReadLineOptions): Interface;
+}
+declare module 'node:readline/promises' {
+    export * from 'readline/promises';
+}