Trevor Norris
51b6b6844e
doc: fix brackets for optional parameters
Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:
fs.write(fd, data[, position[, encoding]], callback)
This simply fixes all uses of bracket notation in documentation.
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Fedor Indutny <fedor@indutny.com>
10 years ago
Yazhong Liu
a4f2f9ea8a
doc: add spec for util.deprecate()
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
11 years ago
Evan Carroll
95dbb6bf64
util: made util.isArray a direct alias for Array.isArray
11 years ago
isaacs
02eb9c834a
doc: Adjust util stability index to 'API Frozen'
Closes #6087
11 years ago
isaacs
73d328de24
doc: Adjust util stability index to 'API Frozen'
Closes #6087
11 years ago
Timothy J Fontaine
546ae2eef9
util: pass opts to custom inspect functions
Objects with custom inpsect functions should get the options that were
passed to `util.inspect()`
fixes #5822
fixes #6098
12 years ago
Ben Noordhuis
2cd7adc7f4
util: don't throw on circular %j input to format()
Don't throw an exception when the argument to %j is an object that
contains circular references, it's not helpful. Catch the exception
and return the string '[Circular]'.
12 years ago
isaacs
896b2aa707
util: Add debuglog, deprecate console lookalikes
12 years ago
Nathan Rajlich
3288bc9532
doc: fix inpect() -> inspect() typo
12 years ago
Nathan Rajlich
66280de133
util: custom `inspect()` method may return an Object
This is more like how `JSON.stringify()` works.
Closes #2711 .
12 years ago
Nathan Rajlich
4eb5399bb2
util: add a "customInspect" option to `util.inspect()`
For disabling calling the custom `inspect()` function when defined on an object
that is being inspected.
12 years ago
Nathan Rajlich
07774e6b95
util: make `inspect()` accept an "options" argument
Consolidates all the formatting options into an "options" object argument.
This is so that we don't have to be constantly remembering the order of
the arguments and so that we can add more formatting options easily.
Closes #4085 .
12 years ago
Nathan Rajlich
f826b3269d
doc: document the custom "inspect()" function behavior
Closes #3361 .
12 years ago
isaacs
0414e14702
doc: util.pump is deprecated. Use Stream.pipe
Conflicts:
doc/api/util.markdown
13 years ago
isaacs
4ff56aa15e
doc: util.pump is deprecated. Use Stream.pipe
13 years ago
Ben Noordhuis
3219616f43
util: mark util.pump() as deprecated
13 years ago
Pavel Lang
ff14007573
Enable color customization of `util.inspect`
This is rewrite of #3701 and #3603 before.
This patch introduce `util.inspect.styles`
and `util.inspect.colors` objects, which enables customization
of color sequences.
13 years ago
Kyle Robinson Young
d9bad09ede
doc: util: add args to format and methods error, puts, print
13 years ago
isaacs
2d44dcc8be
doc: Add stability indicators to documentation
13 years ago
isaacs
3c195d04f3
doc refactor: util
13 years ago
isaacs
8e6086b403
doc refactor: util
13 years ago
koichik
e1c043f43a
docs: fix docs to not suggest variable leaks
Fixes #2106 .
13 years ago
Tim Oxley
871194d5fd
docs: document util.inspect's colors param
13 years ago
Nathan Rajlich
3524f41a27
Add docs for the type checking functions in `util.js`.
13 years ago
koichik
d439c092c2
Improve util.format() compatibility with browser.
Fixes #1434 .
14 years ago
koichik
ae77b4d553
Doc improvements
Documents util.format().
Thanks @bnoordhuis and @shigeki .
Fixes #1424 .
14 years ago
Ryan Dahl
0cb4484d43
Doc improvements
Fixes #1147 .
Fixes #1139 .
Fixes #1126 .
Thanks ctide, kext, disfated.
14 years ago
Ryan Dahl
b92329667f
Fix spelling mistakes
14 years ago
Marco Rogers
5749f91814
Docs for util.inherits
14 years ago
Ryan Dahl
c6029c75a4
Remove util.print from docs
Use process.stdout.write()
14 years ago
Micheil Smith
e190c9616e
Splitting documentation
14 years ago