0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00
nodejs/doc/api/console.markdown

76 lines
1.9 KiB
Markdown
Raw Normal View History

2012-02-27 20:09:34 +01:00
# console
Stability: 4 - API Frozen
2012-02-27 20:09:34 +01:00
* {Object}
<!--type=global-->
2011-04-19 01:52:53 +02:00
For printing to stdout and stderr. Similar to the console object functions
provided by most web browsers, here the output is sent to stdout or stderr.
The console functions are synchronous when the destination is a terminal or
a file (to avoid lost messages in case of premature exit) and asynchronous
when it's a pipe (to avoid blocking for long periods of time).
That is, in the following example, stdout is non-blocking while stderr
is blocking:
$ node script.js 2> error.log | tee info.log
In daily use, the blocking/non-blocking dichotomy is not something you
should worry about unless you log huge amounts of data.
2012-04-21 19:55:14 +02:00
## console.log([data], [...])
2011-04-19 01:52:53 +02:00
Prints to stdout with newline. This function can take multiple arguments in a
`printf()`-like way. Example:
console.log('count: %d', count);
2011-11-26 03:26:11 +01:00
If formatting elements are not found in the first string then `util.inspect`
is used on each argument. See [util.format()][] for more information.
2011-04-19 01:52:53 +02:00
2012-04-21 19:55:14 +02:00
## console.info([data], [...])
2011-04-19 01:52:53 +02:00
Same as `console.log`.
2012-04-21 19:55:14 +02:00
## console.error([data], [...])
2011-04-19 01:52:53 +02:00
Same as `console.log` but prints to stderr.
2012-04-21 19:55:14 +02:00
## console.warn([data], [...])
Same as `console.error`.
2012-02-27 20:09:34 +01:00
## console.dir(obj)
2011-04-19 01:52:53 +02:00
Uses `util.inspect` on `obj` and prints resulting string to stdout.
2011-04-19 01:52:53 +02:00
2012-02-27 20:09:34 +01:00
## console.time(label)
2011-04-19 01:52:53 +02:00
Mark a time.
2012-02-27 20:09:34 +01:00
## console.timeEnd(label)
2011-04-19 01:52:53 +02:00
2012-04-21 19:55:14 +02:00
Finish timer, record output. Example:
2011-04-19 01:52:53 +02:00
console.time('100-elements');
for (var i = 0; i < 100; i++) {
2011-04-19 01:52:53 +02:00
;
}
console.timeEnd('100-elements');
2012-04-21 19:55:14 +02:00
## console.trace(label)
2011-04-19 01:52:53 +02:00
Print a stack trace to stderr of the current position.
2012-04-21 19:55:14 +02:00
## console.assert(expression, [message])
2011-04-19 01:52:53 +02:00
Same as [assert.ok()][] where if the `expression` evaluates as `false` throw an
AssertionError with `message`.
2011-04-19 01:52:53 +02:00
[assert.ok()]: assert.html#assert_assert_value_message_assert_ok_value_message
[util.format()]: util.html#util_util_format_format