Permalink
Browse files

doc: deprecate buffer's parent property

`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: #8332
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
  • Loading branch information...
thefourtheye committed Jan 10, 2017
1 parent 03d440e commit d708700c688ec2b459f1cc6bdac930c20d1a0e0e
Showing with 7 additions and 0 deletions.
  1. +7 −0 doc/api/buffer.md
View
@@ -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

0 comments on commit d708700

Please sign in to comment.