Node.js v18.12.1 documentation


Table of contents

Console#

Stability: 2 - Stable

Source Code: lib/console.js

The node:console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.node:console模块提供了一个简单的调试控制台,类似于web浏览器提供的JavaScript控制台机制。

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.具有console.log()console.error()console.warn()等方法的Console类,可用于写入任何Node.js流。
  • A global console instance configured to write to process.stdout and process.stderr. 配置为写入process.stdoutprocess.stderr的全局console实例。The global console can be used without calling require('node:console').全局console可以在不调用require('node:console')的情况下使用。

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. :全局控制台对象的方法既不像它们类似的浏览器API那样一致地同步,也不像所有其他Node.js流那样一致地异步。See the note on process I/O for more information.有关更多信息,请参阅有关进程I/O的说明

Example using the global console:使用全局console的示例:

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:使用Console类的示例:

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