add docs for console object

This commit is contained in:
Ryan Dahl 2011-04-18 16:52:53 -07:00
parent cbdd92e184
commit d3d35ec3ca
4 changed files with 58 additions and 0 deletions

View File

@ -2,6 +2,7 @@
* [Synopsis](synopsis.html)
* [Globals](globals.html)
* [STDIO](stdio.html)
* [Timers](timers.html)
* [Modules](modules.html)
* [C/C++ Addons](addons.html)

View File

@ -1,6 +1,7 @@
@include synopsis
@include globals
@include stdio
@include timers
@include modules
@include addons

View File

@ -16,6 +16,11 @@ scope; `var something` inside a Node module will be local to that module.
The process object. See the [process object](process.html#process) section.
### console
Used to print to stdout and stderr. See the [stdio](stdio.html) section.
### require()
To require modules. See the [Modules](modules.html#modules) section.

51
doc/api/stdio.markdown Normal file
View File

@ -0,0 +1,51 @@
## console
Browser-like object for printing to stdout and stderr.
### console.log()
Prints to stdout with newline. This function can take multiple arguments in a
`printf()`-like way. Example:
console.log('count: %d', count);
If formating elements are not found in the first string then `util.inspect`
is used on each argument.
### console.info()
Same as `console.log`.
### console.warn()
### console.error()
Same as `console.log` but prints to stderr.
### console.dir(obj)
Uses `util.inspect` on `obj` and prints resulting string to stderr.
### console.time(label)
Mark a time.
### console.timeEnd(label)
Finish timer, record output. Example
console.time('100-elements');
while (var i = 0; i < 100; i++) {
;
}
console.timeEnd('100-elements');
### console.trace()
Print a stack trace to stderr of the current position.
### console.assert()
Same as `assert.ok()`.