Browse Source

doc: add args to console methods

v0.9.1-release
Kyle Robinson Young 13 years ago
committed by Ben Noordhuis
parent
commit
e02d5c9d41
  1. 23
      doc/api/stdio.markdown

23
doc/api/stdio.markdown

@ -9,8 +9,7 @@
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.
## console.log()
## console.log([data], [...])
Prints to stdout with newline. This function can take multiple arguments in a
`printf()`-like way. Example:
@ -21,15 +20,18 @@ If formatting elements are not found in the first string then `util.inspect`
is used on each argument.
See [util.format()](util.html#util.format) for more information.
## console.info()
## console.info([data], [...])
Same as `console.log`.
## console.warn()
## console.error()
## console.error([data], [...])
Same as `console.log` but prints to stderr.
## console.warn([data], [...])
Same as `console.error`.
## console.dir(obj)
Uses `util.inspect` on `obj` and prints resulting string to stdout.
@ -38,10 +40,9 @@ Uses `util.inspect` on `obj` and prints resulting string to stdout.
Mark a time.
## console.timeEnd(label)
Finish timer, record output. Example
Finish timer, record output. Example:
console.time('100-elements');
for (var i = 0; i < 100; i++) {
@ -49,12 +50,12 @@ Finish timer, record output. Example
}
console.timeEnd('100-elements');
## console.trace()
## console.trace(label)
Print a stack trace to stderr of the current position.
## console.assert()
## console.assert(expression, [message])
Same as `assert.ok()`.
Same as [assert.ok()](assert.html#assert_assert_value_message_assert_ok_value_message)
where if the `expression` evaluates as `false` throw an AssertionError with `message`.

Loading…
Cancel
Save