Skip to content

Commit 3b98038

Browse files
devsnekBridgeAR
authored andcommitted
doc: clarify util.inspect usage intent
PR-URL: nodejs#17375 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent b13233a commit 3b98038

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/util.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,9 @@ changes:
348348
line. Defaults to 60 for legacy compatibility.
349349

350350
The `util.inspect()` method returns a string representation of `object` that is
351-
primarily useful for debugging. Additional `options` may be passed that alter
352-
certain aspects of the formatted string.
351+
intended for debugging. The output of `util.inspect` may change at any time
352+
and should not be depended upon programmatically. Additional `options` may be
353+
passed that alter certain aspects of the formatted string.
353354
`util.inspect()` will use the constructor's name and/or `@@toStringTag` to make an
354355
identifiable tag for an inspected value.
355356

0 commit comments

Comments
 (0)