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
Next Next commit
doc: document buffer.buffer property 
Buffer objects expose the underlying `Uint8Array`'s `buffer` property
by default. This patch formally documents it.
  • Loading branch information
@thefourtheye
thefourtheye committed Jan 10, 2017
commit 930d1d7ad090bbbf99ba8cbfc9befd23baa92816
13 changes: 13 additions & 0 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,19 @@ for (let i = 0; i < str.length ; i++) {
console.log(buf.toString('ascii'));
```

### buf.buffer

The `buffer` property references the underlying `ArrayBuffer` object based on
which this Buffer object is created.

```js
const arrayBuffer = new ArrayBuffer(16);
const buffer = Buffer.from(arrayBuffer);

console.log(buffer.buffer === arrayBuffer);
// Prints: true
```

### buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])
<!-- YAML
added: v0.11.13
Expand Down