diff options
author | Sakthipriyan Vairamani (thefourtheye) <thechargingvolcano@gmail.com> | 2017-01-11 00:55:48 +0530 |
---|---|---|
committer | Sakthipriyan Vairamani (thefourtheye) <thechargingvolcano@gmail.com> | 2017-01-18 11:51:46 +0530 |
commit | 03d440e3ced202221e6b95b718d35941af25b16f (patch) | |
tree | 317ec1fd28b66052b1cce4ee5f107a149f37fc3e /doc/api/buffer.md | |
parent | 16e3cf686eb1b8ef38338206a05b6b040c5c841c (diff) | |
download | android-node-v8-03d440e3ced202221e6b95b718d35941af25b16f.tar.gz android-node-v8-03d440e3ced202221e6b95b718d35941af25b16f.tar.bz2 android-node-v8-03d440e3ced202221e6b95b718d35941af25b16f.zip |
doc: document buffer.buffer property
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>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r-- | doc/api/buffer.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 227e5257ea..d506cc1a11 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -879,6 +879,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 |