| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452 |
- /**
- * The `node:console` module provides a simple debugging console that is similar to
- * the JavaScript console mechanism provided by web browsers.
- *
- * The module exports two specific components:
- *
- * * A `Console` class with methods such as `console.log()`, `console.error()`, and `console.warn()` that can be used to write to any Node.js stream.
- * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstdout) and
- * [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
- *
- * _**Warning**_: The global console object's methods are neither consistently
- * synchronous like the browser APIs they resemble, nor are they consistently
- * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v22.x/api/process.html#a-note-on-process-io) for
- * more information.
- *
- * Example using the global `console`:
- *
- * ```js
- * console.log('hello world');
- * // Prints: hello world, to stdout
- * console.log('hello %s', 'world');
- * // Prints: hello world, to stdout
- * console.error(new Error('Whoops, something bad happened'));
- * // Prints error message and stack trace to stderr:
- * // Error: Whoops, something bad happened
- * // at [eval]:5:15
- * // at Script.runInThisContext (node:vm:132:18)
- * // at Object.runInThisContext (node:vm:309:38)
- * // at node:internal/process/execution:77:19
- * // at [eval]-wrapper:6:22
- * // at evalScript (node:internal/process/execution:76:60)
- * // at node:internal/main/eval_string:23:3
- *
- * const name = 'Will Robinson';
- * console.warn(`Danger ${name}! Danger!`);
- * // Prints: Danger Will Robinson! Danger!, to stderr
- * ```
- *
- * Example using the `Console` class:
- *
- * ```js
- * const out = getStreamSomehow();
- * const err = getStreamSomehow();
- * const myConsole = new console.Console(out, err);
- *
- * myConsole.log('hello world');
- * // Prints: hello world, to out
- * myConsole.log('hello %s', 'world');
- * // Prints: hello world, to out
- * myConsole.error(new Error('Whoops, something bad happened'));
- * // Prints: [Error: Whoops, something bad happened], to err
- *
- * const name = 'Will Robinson';
- * myConsole.warn(`Danger ${name}! Danger!`);
- * // Prints: Danger Will Robinson! Danger!, to err
- * ```
- * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/console.js)
- */
- declare module "console" {
- import console = require("node:console");
- export = console;
- }
- declare module "node:console" {
- import { InspectOptions } from "node:util";
- global {
- // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build
- interface Console {
- Console: console.ConsoleConstructor;
- /**
- * `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
- * writes a message and does not otherwise affect execution. The output always
- * starts with `"Assertion failed"`. If provided, `message` is formatted using
- * [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args).
- *
- * If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
- *
- * ```js
- * console.assert(true, 'does nothing');
- *
- * console.assert(false, 'Whoops %s work', 'didn\'t');
- * // Assertion failed: Whoops didn't work
- *
- * console.assert();
- * // Assertion failed
- * ```
- * @since v0.1.101
- * @param value The value tested for being truthy.
- * @param message All arguments besides `value` are used as error message.
- */
- assert(value: any, message?: string, ...optionalParams: any[]): void;
- /**
- * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
- * TTY. When `stdout` is not a TTY, this method does nothing.
- *
- * The specific operation of `console.clear()` can vary across operating systems
- * and terminal types. For most Linux operating systems, `console.clear()` operates similarly to the `clear` shell command. On Windows, `console.clear()` will clear only the output in the
- * current terminal viewport for the Node.js
- * binary.
- * @since v8.3.0
- */
- clear(): void;
- /**
- * Maintains an internal counter specific to `label` and outputs to `stdout` the
- * number of times `console.count()` has been called with the given `label`.
- *
- * ```js
- * > console.count()
- * default: 1
- * undefined
- * > console.count('default')
- * default: 2
- * undefined
- * > console.count('abc')
- * abc: 1
- * undefined
- * > console.count('xyz')
- * xyz: 1
- * undefined
- * > console.count('abc')
- * abc: 2
- * undefined
- * > console.count()
- * default: 3
- * undefined
- * >
- * ```
- * @since v8.3.0
- * @param [label='default'] The display label for the counter.
- */
- count(label?: string): void;
- /**
- * Resets the internal counter specific to `label`.
- *
- * ```js
- * > console.count('abc');
- * abc: 1
- * undefined
- * > console.countReset('abc');
- * undefined
- * > console.count('abc');
- * abc: 1
- * undefined
- * >
- * ```
- * @since v8.3.0
- * @param [label='default'] The display label for the counter.
- */
- countReset(label?: string): void;
- /**
- * The `console.debug()` function is an alias for {@link log}.
- * @since v8.0.0
- */
- debug(message?: any, ...optionalParams: any[]): void;
- /**
- * Uses [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options) on `obj` and prints the resulting string to `stdout`.
- * This function bypasses any custom `inspect()` function defined on `obj`.
- * @since v0.1.101
- */
- dir(obj: any, options?: InspectOptions): void;
- /**
- * This method calls `console.log()` passing it the arguments received.
- * This method does not produce any XML formatting.
- * @since v8.0.0
- */
- dirxml(...data: any[]): void;
- /**
- * Prints to `stderr` with newline. Multiple arguments can be passed, with the
- * first used as the primary message and all additional used as substitution
- * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
- * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)).
- *
- * ```js
- * const code = 5;
- * console.error('error #%d', code);
- * // Prints: error #5, to stderr
- * console.error('error', code);
- * // Prints: error 5, to stderr
- * ```
- *
- * If formatting elements (e.g. `%d`) are not found in the first string then
- * [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options) is called on each argument and the
- * resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)
- * for more information.
- * @since v0.1.100
- */
- error(message?: any, ...optionalParams: any[]): void;
- /**
- * Increases indentation of subsequent lines by spaces for `groupIndentation` length.
- *
- * If one or more `label`s are provided, those are printed first without the
- * additional indentation.
- * @since v8.5.0
- */
- group(...label: any[]): void;
- /**
- * An alias for {@link group}.
- * @since v8.5.0
- */
- groupCollapsed(...label: any[]): void;
- /**
- * Decreases indentation of subsequent lines by spaces for `groupIndentation` length.
- * @since v8.5.0
- */
- groupEnd(): void;
- /**
- * The `console.info()` function is an alias for {@link log}.
- * @since v0.1.100
- */
- info(message?: any, ...optionalParams: any[]): void;
- /**
- * Prints to `stdout` with newline. Multiple arguments can be passed, with the
- * first used as the primary message and all additional used as substitution
- * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
- * (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)).
- *
- * ```js
- * const count = 5;
- * console.log('count: %d', count);
- * // Prints: count: 5, to stdout
- * console.log('count:', count);
- * // Prints: count: 5, to stdout
- * ```
- *
- * See [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args) for more information.
- * @since v0.1.100
- */
- log(message?: any, ...optionalParams: any[]): void;
- /**
- * Try to construct a table with the columns of the properties of `tabularData` (or use `properties`) and rows of `tabularData` and log it. Falls back to just
- * logging the argument if it can't be parsed as tabular.
- *
- * ```js
- * // These can't be parsed as tabular data
- * console.table(Symbol());
- * // Symbol()
- *
- * console.table(undefined);
- * // undefined
- *
- * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
- * // ┌─────────┬─────┬─────┐
- * // │ (index) │ a │ b │
- * // ├─────────┼─────┼─────┤
- * // │ 0 │ 1 │ 'Y' │
- * // │ 1 │ 'Z' │ 2 │
- * // └─────────┴─────┴─────┘
- *
- * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
- * // ┌─────────┬─────┐
- * // │ (index) │ a │
- * // ├─────────┼─────┤
- * // │ 0 │ 1 │
- * // │ 1 │ 'Z' │
- * // └─────────┴─────┘
- * ```
- * @since v10.0.0
- * @param properties Alternate properties for constructing the table.
- */
- table(tabularData: any, properties?: readonly string[]): void;
- /**
- * Starts a timer that can be used to compute the duration of an operation. Timers
- * are identified by a unique `label`. Use the same `label` when calling {@link timeEnd} to stop the timer and output the elapsed time in
- * suitable time units to `stdout`. For example, if the elapsed
- * time is 3869ms, `console.timeEnd()` displays "3.869s".
- * @since v0.1.104
- * @param [label='default']
- */
- time(label?: string): void;
- /**
- * Stops a timer that was previously started by calling {@link time} and
- * prints the result to `stdout`:
- *
- * ```js
- * console.time('bunch-of-stuff');
- * // Do a bunch of stuff.
- * console.timeEnd('bunch-of-stuff');
- * // Prints: bunch-of-stuff: 225.438ms
- * ```
- * @since v0.1.104
- * @param [label='default']
- */
- timeEnd(label?: string): void;
- /**
- * For a timer that was previously started by calling {@link time}, prints
- * the elapsed time and other `data` arguments to `stdout`:
- *
- * ```js
- * console.time('process');
- * const value = expensiveProcess1(); // Returns 42
- * console.timeLog('process', value);
- * // Prints "process: 365.227ms 42".
- * doExpensiveProcess2(value);
- * console.timeEnd('process');
- * ```
- * @since v10.7.0
- * @param [label='default']
- */
- timeLog(label?: string, ...data: any[]): void;
- /**
- * Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)
- * formatted message and stack trace to the current position in the code.
- *
- * ```js
- * console.trace('Show me');
- * // Prints: (stack trace will vary based on where trace is called)
- * // Trace: Show me
- * // at repl:2:9
- * // at REPLServer.defaultEval (repl.js:248:27)
- * // at bound (domain.js:287:14)
- * // at REPLServer.runBound [as eval] (domain.js:300:12)
- * // at REPLServer.<anonymous> (repl.js:412:12)
- * // at emitOne (events.js:82:20)
- * // at REPLServer.emit (events.js:169:7)
- * // at REPLServer.Interface._onLine (readline.js:210:10)
- * // at REPLServer.Interface._line (readline.js:549:8)
- * // at REPLServer.Interface._ttyWrite (readline.js:826:14)
- * ```
- * @since v0.1.104
- */
- trace(message?: any, ...optionalParams: any[]): void;
- /**
- * The `console.warn()` function is an alias for {@link error}.
- * @since v0.1.100
- */
- warn(message?: any, ...optionalParams: any[]): void;
- // --- Inspector mode only ---
- /**
- * This method does not display anything unless used in the inspector. The `console.profile()`
- * method starts a JavaScript CPU profile with an optional label until {@link profileEnd}
- * is called. The profile is then added to the Profile panel of the inspector.
- *
- * ```js
- * console.profile('MyLabel');
- * // Some code
- * console.profileEnd('MyLabel');
- * // Adds the profile 'MyLabel' to the Profiles panel of the inspector.
- * ```
- * @since v8.0.0
- */
- profile(label?: string): void;
- /**
- * This method does not display anything unless used in the inspector. Stops the current
- * JavaScript CPU profiling session if one has been started and prints the report to the
- * Profiles panel of the inspector. See {@link profile} for an example.
- *
- * If this method is called without a label, the most recently started profile is stopped.
- * @since v8.0.0
- */
- profileEnd(label?: string): void;
- /**
- * This method does not display anything unless used in the inspector. The `console.timeStamp()`
- * method adds an event with the label `'label'` to the Timeline panel of the inspector.
- * @since v8.0.0
- */
- timeStamp(label?: string): void;
- }
- /**
- * The `console` module provides a simple debugging console that is similar to the
- * JavaScript console mechanism provided by web browsers.
- *
- * The module exports two specific components:
- *
- * * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream.
- * * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstdout) and
- * [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
- *
- * _**Warning**_: The global console object's methods are neither consistently
- * synchronous like the browser APIs they resemble, nor are they consistently
- * asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v22.x/api/process.html#a-note-on-process-io) for
- * more information.
- *
- * Example using the global `console`:
- *
- * ```js
- * console.log('hello world');
- * // Prints: hello world, to stdout
- * console.log('hello %s', 'world');
- * // Prints: hello world, to stdout
- * console.error(new Error('Whoops, something bad happened'));
- * // Prints error message and stack trace to stderr:
- * // Error: Whoops, something bad happened
- * // at [eval]:5:15
- * // at Script.runInThisContext (node:vm:132:18)
- * // at Object.runInThisContext (node:vm:309:38)
- * // at node:internal/process/execution:77:19
- * // at [eval]-wrapper:6:22
- * // at evalScript (node:internal/process/execution:76:60)
- * // at node:internal/main/eval_string:23:3
- *
- * const name = 'Will Robinson';
- * console.warn(`Danger ${name}! Danger!`);
- * // Prints: Danger Will Robinson! Danger!, to stderr
- * ```
- *
- * Example using the `Console` class:
- *
- * ```js
- * const out = getStreamSomehow();
- * const err = getStreamSomehow();
- * const myConsole = new console.Console(out, err);
- *
- * myConsole.log('hello world');
- * // Prints: hello world, to out
- * myConsole.log('hello %s', 'world');
- * // Prints: hello world, to out
- * myConsole.error(new Error('Whoops, something bad happened'));
- * // Prints: [Error: Whoops, something bad happened], to err
- *
- * const name = 'Will Robinson';
- * myConsole.warn(`Danger ${name}! Danger!`);
- * // Prints: Danger Will Robinson! Danger!, to err
- * ```
- * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/console.js)
- */
- namespace console {
- interface ConsoleConstructorOptions {
- stdout: NodeJS.WritableStream;
- stderr?: NodeJS.WritableStream | undefined;
- /**
- * Ignore errors when writing to the underlying streams.
- * @default true
- */
- ignoreErrors?: boolean | undefined;
- /**
- * Set color support for this `Console` instance. Setting to true enables coloring while inspecting
- * values. Setting to `false` disables coloring while inspecting values. Setting to `'auto'` makes color
- * support depend on the value of the `isTTY` property and the value returned by `getColorDepth()` on the
- * respective stream. This option can not be used, if `inspectOptions.colors` is set as well.
- * @default auto
- */
- colorMode?: boolean | "auto" | undefined;
- /**
- * Specifies options that are passed along to
- * [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options).
- */
- inspectOptions?: InspectOptions | undefined;
- /**
- * Set group indentation.
- * @default 2
- */
- groupIndentation?: number | undefined;
- }
- interface ConsoleConstructor {
- prototype: Console;
- new(stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): Console;
- new(options: ConsoleConstructorOptions): Console;
- }
- }
- var console: Console;
- }
- export = globalThis.console;
- }
|