Skip to content

Commit

Permalink
doc: add reference for buffer.inspect()
Browse files Browse the repository at this point in the history
This commit refers readers to util.inspect() for an explanation
of buffer.inspect().

Fixes: #3918
PR-URL: #3921
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
  • Loading branch information
cjihrig authored and jasnell committed Dec 17, 2015
1 parent 4bc71e0 commit 8eb28c3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/buffer.markdown
Original file line number Diff line number Diff line change
@@ -882,7 +882,8 @@ to `false`.
* Number, Default: 50

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

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

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

0 comments on commit 8eb28c3

Please sign in to comment.