Node.js v24.0.0 文档

new Console(stdout[, stderr][, ignoreErrors])#

new Console(options)#

• options <Object>
  • stdout <stream.Writable>
  • stderr <stream.Writable>
  • ignoreErrors <boolean> 写入底层流时忽略错误。 默认值: true。
  • colorMode <boolean> | <string> 设置此 Console 实例的颜色支持。 设置为 true 会在检查值时启用着色。 设置为 false 会在检查值时禁用着色。 设置为 'auto' 使颜色支持取决于 isTTY 属性的值以及 getColorDepth() 在相应流上返回的值。 如果也设置了 inspectOptions.colors，则不能使用此选项。 默认值: 'auto'。
  • inspectOptions <Object> 指定传递给 util.inspect() 的选项。
  • groupIndentation <number> 设置组缩进。 默认值: 2。

创建一个新的 Console，其中包含一个或两个可写流实例。 stdout 是一个可写流，用于打印日志或信息输出。 stderr 用于警告或错误输出。 如果未提供 stderr，则 stdout 用于 stderr。

import { createWriteStream } from 'node:fs';
import { Console } from 'node:console';
// Alternatively
// const { Console } = console;

const output = createWriteStream('./stdout.log');
const errorOutput = createWriteStream('./stderr.log');
// Custom simple logger
const logger = new Console({ stdout: output, stderr: errorOutput });
// use it like console
const count = 5;
logger.log('count: %d', count);
// In stdout.log: count 5const fs = require('node:fs');
const { Console } = require('node:console');
// Alternatively
// const { Console } = console;

const output = fs.createWriteStream('./stdout.log');
const errorOutput = fs.createWriteStream('./stderr.log');
// Custom simple logger
const logger = new Console({ stdout: output, stderr: errorOutput });
// use it like console
const count = 5;
logger.log('count: %d', count);
// In stdout.log: count 5copy

全局 console 是一个特殊的 Console，其输出被发送到 process.stdout 和 process.stderr。 它相当于调用

new Console({ stdout: process.stdout, stderr: process.stderr }); copy

console.assert(value[, ...message])#

• value <any> 测试是否为真值的值。
• ...message <any> 除了 value 之外的所有参数都用作错误消息。

如果 value 是 假值或被省略，则 console.assert() 写入消息。 它仅写入消息，不会以其他方式影响执行。 输出始终以 "Assertion failed" 开头。 如果提供，则使用 util.format() 格式化 message。

如果 value 是 真值，则什么也不会发生。

console.assert(true, 'does nothing');

console.assert(false, 'Whoops %s work', 'didn\'t');
// Assertion failed: Whoops didn't work

console.assert();
// Assertion failed copy

console.clear()#

当 stdout 是 TTY 时，调用 console.clear() 将尝试清除 TTY。 当 stdout 不是 TTY 时，此方法不执行任何操作。

console.clear() 的具体操作可能因操作系统和终端类型而异。 对于大多数 Linux 操作系统，console.clear() 的操作类似于 clear shell 命令。 在 Windows 上，console.clear() 将仅清除 Node.js 二进制文件的当前终端视口中的输出。

console.count([label])#

• label <string> 计数器的显示标签。 默认值: 'default'。

维护一个特定于 label 的内部计数器，并将 console.count() 使用给定 label 调用的次数输出到 stdout。

> 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
> copy

console.countReset([label])#

• label <string> 计数器的显示标签。 默认值: 'default'。

重置特定于 label 的内部计数器。

> console.count('abc');
abc: 1
undefined
> console.countReset('abc');
undefined
> console.count('abc');
abc: 1
undefined
> copy

console.debug(data[, ...args])#

• data <any>
• ...args <any>

console.debug() 函数是 console.log() 的别名。

console.dir(obj[, options])#

• obj <any>
• options <Object>
  • showHidden <boolean> 如果为 true，则也会显示对象的不可枚举属性和符号属性。 默认值: false。
  • depth <number> 告诉 util.inspect() 在格式化对象时递归多少次。这对于检查大型复杂对象很有用。要使其无限递归，请传递 null。默认值: 2。
  • colors <boolean> 如果为 true，则输出将使用 ANSI 颜色代码进行样式设置。颜色是可定制的；请参阅自定义 util.inspect() 颜色。默认值: false。

对 obj 使用 util.inspect() 并将结果字符串打印到 stdout。此函数绕过在 obj 上定义的任何自定义 inspect() 函数。

console.dirxml(...data)#

• ...data <any>

此方法调用 console.log() 并传递收到的参数。此方法不产生任何 XML 格式。

console.error([data][, ...args])#

• data <any>
• ...args <any>

使用换行符打印到 stderr。可以传递多个参数，第一个用作主要消息，所有附加参数用作类似于printf(3)的替换值（所有参数都传递给util.format()）。

const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr copy

如果在第一个字符串中未找到格式化元素（例如 %d），则对每个参数调用util.inspect()，并将结果字符串值连接起来。有关更多信息，请参见util.format()。

console.group([...label])#

• ...label <any>

将后续行的缩进增加 groupIndentation 长度的空间。

如果提供了一个或多个 label，则首先打印它们，而无需额外的缩进。

console.groupCollapsed()#

是 console.group() 的别名。

console.groupEnd()#

将后续行的缩进减少 groupIndentation 长度的空间。

console.info([data][, ...args])#

• data <any>
• ...args <any>

console.info() 函数是 console.log() 的别名。

console.log([data][, ...args])#

• data <any>
• ...args <any>

使用换行符打印到 stdout。可以传递多个参数，第一个用作主要消息，所有附加参数用作类似于printf(3)的替换值（所有参数都传递给util.format()）。

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout copy

有关更多信息，请参见util.format()。

console.table(tabularData[, properties])#

• tabularData <any>
• properties <string[]> 用于构造表格的备用属性。

尝试使用 tabularData 的属性列（或使用 properties）和 tabularData 的行构造一个表格并记录它。如果无法解析为表格，则回退到仅记录参数。

// 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' │
// └─────────┴─────┘ copy

console.time([label])#

• label <string> 默认值: 'default'

启动一个计时器，可用于计算操作的持续时间。计时器由唯一的 label 标识。调用 console.timeEnd() 时使用相同的 label 来停止计时器并将经过的时间以适当的时间单位输出到 stdout。例如，如果经过的时间为 3869 毫秒，则 console.timeEnd() 显示 "3.869s"。

console.timeEnd([label])#

• label <string> 默认值: 'default'

停止先前通过调用 console.time() 启动的计时器，并将结果打印到 stdout

console.time('bunch-of-stuff');
// Do a bunch of stuff.
console.timeEnd('bunch-of-stuff');
// Prints: bunch-of-stuff: 225.438ms copy

console.timeLog([label][, ...data])#

• label <string> 默认值: 'default'
• ...data <any>

对于先前通过调用 console.time() 启动的计时器，将经过的时间和其他 data 参数打印到 stdout

console.time('process');
const value = expensiveProcess1(); // Returns 42
console.timeLog('process', value);
// Prints "process: 365.227ms 42".
doExpensiveProcess2(value);
console.timeEnd('process'); copy

console.trace([message][, ...args])#

• message <any>
• ...args <any>

将字符串 'Trace: ' 打印到 stderr，后跟 util.format() 格式化的消息和代码中当前位置的堆栈跟踪。

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) copy

console.warn([data][, ...args])#

• data <any>
• ...args <any>

console.warn() 函数是 console.error() 的别名。

console.profile([label])#

• label <string>

除非在 inspector 中使用，否则此方法不显示任何内容。 console.profile() 方法使用可选标签启动 JavaScript CPU 配置文件，直到调用 console.profileEnd()。然后将该配置文件添加到 inspector 的 Profile 面板。

console.profile('MyLabel');
// Some code
console.profileEnd('MyLabel');
// Adds the profile 'MyLabel' to the Profiles panel of the inspector. copy

console.profileEnd([label])#

• label <string>

除非在 inspector 中使用，否则此方法不显示任何内容。 如果已启动当前的 JavaScript CPU 性能分析会话，则停止该会话，并将报告打印到 inspector 的 Profiles 面板。 参见 console.profile() 获取示例。

如果调用此方法时没有标签，则会停止最近启动的配置文件。

console.timeStamp([label])#

• label <string>

除非在 inspector 中使用，否则此方法不显示任何内容。 console.timeStamp() 方法将带有标签 'label' 的事件添加到 inspector 的 Timeline 面板。