Skip to content

Commit 0997178

Browse files
cjihrigrvagg
authored andcommitted
doc: add reference for buffer.inspect()
This commit refers readers to util.inspect() for an explanation of buffer.inspect(). Fixes: #3918 PR-URL: #3921 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]>
1 parent bc27379 commit 0997178

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/buffer.markdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,8 @@ to `false`.
882882
* Number, Default: 50
883883

884884
How many bytes will be returned when `buffer.inspect()` is called. This can
885-
be overridden by user modules.
885+
be overridden by user modules. See [util.inspect()][] for more details on
886+
`buffer.inspect()` behavior.
886887

887888
Note that this is a property on the buffer module returned by
888889
`require('buffer')`, not on the Buffer global, or a buffer instance.
@@ -933,3 +934,4 @@ has actively observed undue memory retention in their applications.
933934

934935
[`buf1.compare(buf2)`]: #buffer_buf_compare_otherbuffer
935936
[Array#indexOf()]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf
937+
[util.inspect()]: util.html#util_util_inspect_object_options

0 commit comments

Comments
 (0)