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

doc: deprecate buffer's parent property

Browse Source 
`buffer.parent` property is actually an alias of `buffer.buffer`
property. This patch actually doc-deprecates it and points the users to
the `buffer.buffer` property.

PR-URL: https://github.com/nodejs/node/pull/8332
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
This commit is contained in:
Sakthipriyan Vairamani (thefourtheye) 2017-01-11 01:00:46 +05:30
parent 03d440e3ce
commit d708700c68
No known key found for this signature in database
GPG Key ID: C71F2437E9591758
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/buffer.md
View File

@ -1329,6 +1329,12 @@ buf = buf.slice(0, 5);
console.log(buf.length);
```
### buf.parent
> Stability: 0 - Deprecated: Use [`buf.buffer`] instead.
The `buf.parent` property is a deprecated alias for `buf.buffer`.
### buf.readDoubleBE(offset[, noAssert])
### buf.readDoubleLE(offset[, noAssert])
<!-- YAML
@ -2429,6 +2435,7 @@ console.log(buf);
```
[`buf.compare()`]: #buffer_buf_compare_target_targetstart_targetend_sourcestart_sourceend
[`buf.buffer`]: #buffer_buf_buffer
[`buf.entries()`]: #buffer_buf_entries
[`buf.indexOf()`]: #buffer_buf_indexof_value_byteoffset_encoding
[`buf.fill()`]: #buffer_buf_fill_value_offset_end_encoding