jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-03 15:17:17 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

doc: document buffer.buffer property

Browse Source 
Buffer objects expose the underlying `Uint8Array`'s `buffer` property
by default. This patch formally documents it.

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 00:55:48 +05:30
parent 16e3cf686e
commit 03d440e3ce
No known key found for this signature in database
GPG Key ID: C71F2437E9591758
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/api/buffer.md
View File

@ -879,6 +879,19 @@ for (let i = 0; i < str.length ; i++) {
console.log(buf.toString('ascii')); 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]]]]) ### buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])
<!-- YAML <!-- YAML
added: v0.11.13 added: v0.11.13