Skip to content

Commit

Permalink
util: doc deprecate legacy inspect signature
Browse files Browse the repository at this point in the history
  • Loading branch information
refack committed Sep 7, 2018
1 parent 12ed7c9 commit cfd0067
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,9 @@ stream.write('With ES6');
<!-- YAML
added: v0.3.0
changes:
- version: REPLACEME
pr-rul: https://github.com/nodejs/node/pull/22753
description: Deprecated legacy signature.
- version: v10.6.0
pr-url: https://github.com/nodejs/node/pull/20725
description: Inspecting linked lists and similar objects is now possible
Expand All @@ -384,6 +387,9 @@ changes:
- version: v6.1.0
pr-url: https://github.com/nodejs/node/pull/6465
description: The `showProxy` option is supported now.
- version: v0.9.3
pr-url: https://github.com/nodejs/node-v0.x-archive/issues/4085
description: Take an "options" object as second argument
-->

* `object` {any} Any JavaScript primitive or `Object`.
Expand Down Expand Up @@ -424,6 +430,9 @@ changes:
example below. **Default:** `true`.
* Returns: {string} The representation of passed object

Deprecation notice: The legacy function signature that was changed in v0.9.3
`util.inspect(object, [showHidden], [depth], [colors])` has been deprecated.

The `util.inspect()` method returns a string representation of `object` that is
intended for debugging. The output of `util.inspect` may change at any time
and should not be depended upon programmatically. Additional `options` may be
Expand Down

0 comments on commit cfd0067

Please sign in to comment.