Console
目录
- Class: Console
- new Console(stdout[, stderr][, ignoreErrors])
- new Console(options)
- console.assert(value[, ...message])
- console.clear()
- console.count([label])
- console.countReset([label])
- console.debug(data[, ...args])
- console.dir(obj[, options])
- console.dirxml(...data)
- console.error([data][, ...args])
- console.group([...label])
- console.groupCollapsed()
- console.groupEnd()
- console.info([data][, ...args])
- console.log([data][, ...args])
- console.table(tabularData[, properties])
- console.time([label])
- console.timeEnd([label])
- console.timeLog([label][, ...data])
- console.trace([message][, ...args])
- console.warn([data][, ...args])
- Inspector only methods
自 v0.10.13 版本开始新增
源代码: lib/console.js
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 asconsole.log()
,console.error()
, andconsole.warn()
that can be used to write to any Node.js stream. - A global
console
instance configured to write toprocess.stdout
andprocess.stderr
. The globalconsole
can be used without callingrequire('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. See the note on process I/O for more information.
Example using the global console
:
JS
Example using the Console
class:
JS
C Console
The Console
class can be used to create a simple logger with configurable
output streams and can be accessed using either require('node:console').Console
or console.Console
(or their destructured counterparts):
JS
JS
M new Console(stdout[, stderr][, ignoreErrors])
M new Console(options)
options
Object
stdout
stream.Writable
stderr
stream.Writable
ignoreErrors
boolean
Ignore errors when writing to the underlying streams. Default:true
.colorMode
boolean
|string
Set color support for thisConsole
instance. Setting totrue
enables coloring while inspecting values. Setting tofalse
disables coloring while inspecting values. Setting to'auto'
makes color support depend on the value of theisTTY
property and the value returned bygetColorDepth()
on the respective stream. This option can not be used, ifinspectOptions.colors
is set as well. Default:'auto'
.inspectOptions
Object
Specifies options that are passed along toutil.inspect()
.groupIndentation
number
Set group indentation. Default:2
.
Creates a new Console
with one or two writable stream instances. stdout
is a
writable stream to print log or info output. stderr
is used for warning or
error output. If stderr
is not provided, stdout
is used for stderr
.
JS
The global console
is a special Console
whose output is sent to
process.stdout
and process.stderr
. It is equivalent to calling:
JS
M console.assert(value[, ...message])
历史
版本 | 历史变更 |
---|---|
v10.0.0 | The implementation is now spec compliant and does not throw anymore. |
v0.1.101 | 自 v0.1.101 版本开始新增 |
value
any
The value tested for being truthy....message
any
All arguments besidesvalue
are used as error message.
console.assert()
writes a message if value
is 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()
.
If value
is truthy, nothing happens.
JS
M console.clear()
自 v8.3.0 版本开始新增
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.
M console.count([label])
自 v8.3.0 版本开始新增
label
string
The display label for the counter. Default:'default'
.
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
M console.countReset([label])
自 v8.3.0 版本开始新增
label
string
The display label for the counter. Default:'default'
.
Resets the internal counter specific to label
.
JS
M console.debug(data[, ...args])
历史
版本 | 历史变更 |
---|---|
v8.10.0 | `console.debug` is now an alias for `console.log`. |
v8.0.0 | 自 v8.0.0 版本开始新增 |
The console.debug()
function is an alias for console.log()
.
M console.dir(obj[, options])
自 v0.1.101 版本开始新增
obj
any
options
Object
showHidden
boolean
Iftrue
then the object's non-enumerable and symbol properties will be shown too. Default:false
.depth
number
Tellsutil.inspect()
how many times to recurse while formatting the object. This is useful for inspecting large complicated objects. To make it recurse indefinitely, passnull
. Default:2
.colors
boolean
Iftrue
, then the output will be styled with ANSI color codes. Colors are customizable; see customizingutil.inspect()
colors. Default:false
.
Uses util.inspect()
on obj
and prints the resulting string to stdout
.
This function bypasses any custom inspect()
function defined on obj
.
M console.dirxml(...data)
历史
版本 | 历史变更 |
---|---|
v9.3.0 | `console.dirxml` now calls `console.log` for its arguments. |
v8.0.0 | 自 v8.0.0 版本开始新增 |
...data
any
This method calls console.log()
passing it the arguments received.
This method does not produce any XML formatting.
M console.error([data][, ...args])
自 v0.1.100 版本开始新增
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) (the arguments are all passed to
util.format()
).
JS
If formatting elements (e.g. %d
) are not found in the first string then
util.inspect()
is called on each argument and the resulting string
values are concatenated. See util.format()
for more information.
M console.group([...label])
自 v8.5.0 版本开始新增
...label
any
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.
M console.groupCollapsed()
自 v8.5.0 版本开始新增
An alias for console.group()
.
M console.groupEnd()
自 v8.5.0 版本开始新增
Decreases indentation of subsequent lines by spaces for groupIndentation
length.
M console.info([data][, ...args])
自 v0.1.100 版本开始新增
The console.info()
function is an alias for console.log()
.
M console.log([data][, ...args])
自 v0.1.100 版本开始新增
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) (the arguments are all passed to
util.format()
).
JS
See util.format()
for more information.
M console.table(tabularData[, properties])
自 v10.0.0 版本开始新增
tabularData
any
properties
string[] Alternate properties for constructing the table.
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
M console.time([label])
自 v0.1.104 版本开始新增
label
string
Default:'default'
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
console.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".
M console.timeEnd([label])
历史
版本 | 历史变更 |
---|---|
v13.0.0 | The elapsed time is displayed with a suitable time unit. |
v6.0.0 | This method no longer supports multiple calls that don't map to individual `console.time()` calls; see below for details. |
v0.1.104 | 自 v0.1.104 版本开始新增 |
label
string
Default:'default'
Stops a timer that was previously started by calling console.time()
and
prints the result to stdout
:
JS
M console.timeLog([label][, ...data])
自 v10.7.0 版本开始新增
For a timer that was previously started by calling console.time()
, prints
the elapsed time and other data
arguments to stdout
:
JS
M console.trace([message][, ...args])
自 v0.1.104 版本开始新增
Prints to stderr
the string 'Trace: '
, followed by the util.format()
formatted message and stack trace to the current position in the code.
JS
M console.warn([data][, ...args])
自 v0.1.100 版本开始新增
The console.warn()
function is an alias for console.error()
.
Inspector only methods
The following methods are exposed by the V8 engine in the general API but do
not display anything unless used in conjunction with the inspector
(--inspect
flag).
M console.profile([label])
自 v8.0.0 版本开始新增
label
string
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 console.profileEnd()
is called. The profile is then added to
the Profile panel of the inspector.
JS
M console.profileEnd([label])
自 v8.0.0 版本开始新增
label
string
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
console.profile()
for an example.
If this method is called without a label, the most recently started profile is stopped.
M console.timeStamp([label])
自 v8.0.0 版本开始新增
label
string
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.