Browse Source

docs: document util.inspect's colors param

v0.7.4-release
Tim Oxley 13 years ago
committed by Ben Noordhuis
parent
commit
871194d5fd
  1. 4
      doc/api/util.markdown

4
doc/api/util.markdown

@ -50,7 +50,7 @@ Output with timestamp on `stdout`.
require('util').log('Timestamped message.'); require('util').log('Timestamped message.');
### util.inspect(object, showHidden=false, depth=2) ### util.inspect(object, showHidden=false, depth=2, colors=false)
Return a string representation of `object`, which is useful for debugging. Return a string representation of `object`, which is useful for debugging.
@ -63,6 +63,8 @@ formatting the object. This is useful for inspecting large complicated objects.
The default is to only recurse twice. To make it recurse indefinitely, pass The default is to only recurse twice. To make it recurse indefinitely, pass
in `null` for `depth`. in `null` for `depth`.
If `colors` is `true`, the output will be styled with ANSI color codes.
Example of inspecting all properties of the `util` object: Example of inspecting all properties of the `util` object:
var util = require('util'); var util = require('util');

Loading…
Cancel
Save