diff --git a/doc/api/_toc.markdown b/doc/api/_toc.markdown index 23df8790887..58419663ae5 100644 --- a/doc/api/_toc.markdown +++ b/doc/api/_toc.markdown @@ -2,6 +2,7 @@ * [Synopsis](synopsis.html) * [Globals](globals.html) +* [STDIO](stdio.html) * [Timers](timers.html) * [Modules](modules.html) * [C/C++ Addons](addons.html) diff --git a/doc/api/all.markdown b/doc/api/all.markdown index fe12ef7e532..5498d17ddae 100644 --- a/doc/api/all.markdown +++ b/doc/api/all.markdown @@ -1,6 +1,7 @@ @include synopsis @include globals +@include stdio @include timers @include modules @include addons diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown index 364a703d4c3..8aceceaed6a 100644 --- a/doc/api/globals.markdown +++ b/doc/api/globals.markdown @@ -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. diff --git a/doc/api/stdio.markdown b/doc/api/stdio.markdown new file mode 100644 index 00000000000..a24d0572c63 --- /dev/null +++ b/doc/api/stdio.markdown @@ -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()`. +