1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add added: information for console

Browse Source 
Information extracted from git history.

Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/6995
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
This commit is contained in:
Adrian Estrada 2016-05-26 11:28:32 -04:00 committed by Anna Henningsen
parent 4a56e89d20
commit 51b8a79bd4
No known key found for this signature in database
GPG Key ID: D8B9F5AEAE84E4CF
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/api/console.md
View File

@ -97,6 +97,9 @@ new Console(process.stdout, process.stderr);
``` ```
### console.assert(value[, message][, ...]) ### console.assert(value[, message][, ...])
<!-- YAML
added: v0.1.101
-->
A simple assertion test that verifies whether `value` is truthy. If it is not, A simple assertion test that verifies whether `value` is truthy. If it is not,
an `AssertionError` is thrown. If provided, the error `message` is formatted an `AssertionError` is thrown. If provided, the error `message` is formatted
@ -150,6 +153,9 @@ console.log('this will also print');
``` ```
### console.dir(obj[, options]) ### console.dir(obj[, options])
<!-- YAML
added: v0.1.101
-->
Uses [`util.inspect()`][] on `obj` and prints the resulting string to `stdout`. Uses [`util.inspect()`][] on `obj` and prints the resulting string to `stdout`.
This function bypasses any custom `inspect()` function defined on `obj`. An This function bypasses any custom `inspect()` function defined on `obj`. An
@ -168,6 +174,9 @@ Defaults to `false`. Colors are customizable; see
[customizing `util.inspect()` colors][]. [customizing `util.inspect()` colors][].
### console.error([data][, ...]) ### console.error([data][, ...])
<!-- YAML
added: v0.1.100
-->
Prints to `stderr` with newline. Multiple arguments can be passed, with the Prints to `stderr` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution first used as the primary message and all additional used as substitution
@ -187,10 +196,16 @@ If formatting elements (e.g. `%d`) are not found in the first string then
values are concatenated. See [`util.format()`][] for more information. values are concatenated. See [`util.format()`][] for more information.
### console.info([data][, ...]) ### console.info([data][, ...])
<!-- YAML
added: v0.1.100
-->
The `console.info()` function is an alias for [`console.log()`][]. The `console.info()` function is an alias for [`console.log()`][].
### console.log([data][, ...]) ### console.log([data][, ...])
<!-- YAML
added: v0.1.100
-->
Prints to `stdout` with newline. Multiple arguments can be passed, with the Prints to `stdout` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution first used as the primary message and all additional used as substitution
@ -210,6 +225,9 @@ If formatting elements (e.g. `%d`) are not found in the first string then
values are concatenated. See [`util.format()`][] for more information. values are concatenated. See [`util.format()`][] for more information.
### console.time(label) ### console.time(label)
<!-- YAML
added: v0.1.104
-->
Starts a timer that can be used to compute the duration of an operation. Timers 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 you call are identified by a unique `label`. Use the same `label` when you call
@ -217,6 +235,9 @@ are identified by a unique `label`. Use the same `label` when you call
milliseconds to stdout. Timer durations are accurate to the sub-millisecond. milliseconds to stdout. Timer durations are accurate to the sub-millisecond.
### console.timeEnd(label) ### console.timeEnd(label)
<!-- YAML
added: v0.1.104
-->
Stops a timer that was previously started by calling [`console.time()`][] and Stops a timer that was previously started by calling [`console.time()`][] and
prints the result to stdout: prints the result to stdout:
@ -236,6 +257,9 @@ leaking it. On older versions, the timer persisted. This allowed
functionality was unintended and is no longer supported.* functionality was unintended and is no longer supported.*
### console.trace(message[, ...]) ### console.trace(message[, ...])
<!-- YAML
added: v0.1.104
-->
Prints to `stderr` the string `'Trace :'`, followed by the [`util.format()`][] Prints to `stderr` the string `'Trace :'`, followed by the [`util.format()`][]
formatted message and stack trace to the current position in the code. formatted message and stack trace to the current position in the code.
@ -257,6 +281,9 @@ console.trace('Show me');
``` ```
### console.warn([data][, ...]) ### console.warn([data][, ...])
<!-- YAML
added: v0.1.100
-->
The `console.warn()` function is an alias for [`console.error()`][]. The `console.warn()` function is an alias for [`console.error()`][].