1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add reference for buffer.inspect()

Browse Source 
This commit refers readers to util.inspect() for an explanation
of buffer.inspect().

Fixes: https://github.com/nodejs/node/issues/3918
PR-URL: https://github.com/nodejs/node/pull/3921
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
This commit is contained in:
cjihrig 2015-11-19 12:16:29 -05:00
parent 007cfea308
commit 5f3ed61094
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/buffer.markdown
View File

@ -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