diff --git a/doc/api/console.markdown b/doc/api/console.markdown index f3a69ce9510..6fe5a400f6f 100644 --- a/doc/api/console.markdown +++ b/doc/api/console.markdown @@ -10,101 +10,6 @@ sent to stdout or stderr. For ease of use, `console` is defined as a global object and can be used directly without `require`. -## console - -* {Object} - - - -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. - - -### console.log([data][, ...]) - -Prints to stdout with newline. This function can take multiple arguments in a -`printf()`-like way. Example: - - var count = 5; - console.log('count: %d', count); - // prints 'count: 5' - -If formatting elements are not found in the first string then `util.inspect` -is used on each argument. See [util.format()][] for more information. - -### console.info([data][, ...]) - -Same as `console.log`. - -### console.error([data][, ...]) - -Same as `console.log` but prints to stderr. - -### console.warn([data][, ...]) - -Same as `console.error`. - -### console.dir(obj[, options]) - -Uses `util.inspect` on `obj` and prints resulting string to stdout. This function -bypasses any custom `inspect()` function on `obj`. An optional *options* object -may be passed that alters certain aspects of the formatted string: - -- `showHidden` - if `true` then the object's non-enumerable and symbol -properties will be shown too. Defaults to `false`. - -- `depth` - tells `inspect` how many times to recurse while formatting the -object. This is useful for inspecting large complicated objects. Defaults to -`2`. To make it recurse indefinitely pass `null`. - -- `colors` - if `true`, then the output will be styled with ANSI color codes. -Defaults to `false`. Colors are customizable, see below. - -### console.time(label) - -Starts a timer that can be used to compute the duration of an operation. Timers -are identified by a unique name. Use the same name when you call -[`console.timeEnd()`](#console_console_timeend_label) to stop the timer and -output the elapsed time in milliseconds. Timer durations are accurate to the -sub-millisecond. - -### console.timeEnd(label) - -Stops a timer that was previously started by calling -[`console.time()`](#console_console_time_label) and prints the result to the -console. - -Example: - - console.time('100-elements'); - for (var i = 0; i < 100; i++) { - ; - } - console.timeEnd('100-elements'); - // prints 100-elements: 225.438ms - -### console.trace(message[, ...]) - -Print to stderr `'Trace :'`, followed by the formatted message and stack trace -to the current position. - -### console.assert(value[, message][, ...]) - -Similar to [assert.ok()][], but the error message is formatted as -`util.format(message...)`. - ## Class: Console @@ -140,3 +45,97 @@ The global `console` is a special `Console` whose output is sent to [assert.ok()]: assert.html#assert_assert_value_message_assert_ok_value_message [util.format()]: util.html#util_util_format_format + +## console + +* {Object} + + + +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. + +### console.assert(value[, message][, ...]) + +Similar to [assert.ok()][], but the error message is formatted as +`util.format(message...)`. + +### console.dir(obj[, options]) + +Uses `util.inspect` on `obj` and prints resulting string to stdout. This function +bypasses any custom `inspect()` function on `obj`. An optional *options* object +may be passed that alters certain aspects of the formatted string: + +- `showHidden` - if `true` then the object's non-enumerable and symbol +properties will be shown too. Defaults to `false`. + +- `depth` - tells `inspect` how many times to recurse while formatting the +object. This is useful for inspecting large complicated objects. Defaults to +`2`. To make it recurse indefinitely pass `null`. + +- `colors` - if `true`, then the output will be styled with ANSI color codes. +Defaults to `false`. Colors are customizable, see below. + +### console.error([data][, ...]) + +Same as `console.log` but prints to stderr. + +### console.info([data][, ...]) + +Same as `console.log`. + +### console.log([data][, ...]) + +Prints to stdout with newline. This function can take multiple arguments in a +`printf()`-like way. Example: + + var count = 5; + console.log('count: %d', count); + // prints 'count: 5' + +If formatting elements are not found in the first string then `util.inspect` +is used on each argument. See [util.format()][] for more information. + +### console.time(label) + +Starts a timer that can be used to compute the duration of an operation. Timers +are identified by a unique name. Use the same name when you call +[`console.timeEnd()`](#console_console_timeend_label) to stop the timer and +output the elapsed time in milliseconds. Timer durations are accurate to the +sub-millisecond. + +### console.timeEnd(label) + +Stops a timer that was previously started by calling +[`console.time()`](#console_console_time_label) and prints the result to the +console. + +Example: + + console.time('100-elements'); + for (var i = 0; i < 100; i++) { + ; + } + console.timeEnd('100-elements'); + // prints 100-elements: 225.438ms + +### console.trace(message[, ...]) + +Print to stderr `'Trace :'`, followed by the formatted message and stack trace +to the current position. + +### console.warn([data][, ...]) + +Same as `console.error`.