Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
add docs for console object
Browse files Browse the repository at this point in the history
  • Loading branch information
ry committed Apr 18, 2011
1 parent cbdd92e commit d3d35ec
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/api/_toc.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* [Synopsis](synopsis.html)
* [Globals](globals.html)
* [STDIO](stdio.html)
* [Timers](timers.html)
* [Modules](modules.html)
* [C/C++ Addons](addons.html)
Expand Down
1 change: 1 addition & 0 deletions doc/api/all.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

@include synopsis
@include globals
@include stdio
@include timers
@include modules
@include addons
Expand Down
5 changes: 5 additions & 0 deletions doc/api/globals.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
51 changes: 51 additions & 0 deletions doc/api/stdio.markdown
Original file line number Diff line number Diff line change
@@ -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()`.

0 comments on commit d3d35ec

Please sign in to comment.