Skip to content

buffer: deprecate parent property #8332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thefourtheye wants to merge 2 commits into from
Closed

buffer: deprecate parent property #8332

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
930d1d7
doc: document buffer.buffer property
thefourtheye Jan 10, 2017
a4a43ac
doc: deprecate buffer's parent property
thefourtheye Jan 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc: deprecate buffer's parent property 
`buffer.parent` property is actually a wrapper over `buffer.buffer`
property. This patch actually doc-deprecates it and points the users to
the `buffer.buffer` property.
  • Loading branch information
@thefourtheye
thefourtheye committed Jan 13, 2017
commit a4a43ac14d82a71001182cde0e6124e63e78ba80
7 changes: 7 additions & 0 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1327,6 +1327,12 @@ buf = buf.slice(0, 5);
console.log(buf.length);
```

### buf.parent

> Stability: 0 - Deprecated: Use [`buf.buffer`] instead.

Copy link
Copy Markdown
Member

@jasnell jasnell Jan 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might add here a quick comment saying something like:

The `buf.parent` property is a deprecated alias for `buf.buffer`.

Copy link
Copy Markdown
Contributor Author

@thefourtheye thefourtheye Jan 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack!

The `buf.parent` property is a deprecated alias for `buf.buffer`.

### buf.readDoubleBE(offset[, noAssert])
### buf.readDoubleLE(offset[, noAssert])
<!-- YAML
Expand Down Expand Up @@ -2427,6 +2433,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
Expand Down