doc: document buffer.buffer property

Buffer objects expose the underlying `Uint8Array`'s `buffer` property by default. This patch formally documents it. PR-URL: nodejs#8332 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
linvinglor · Jan 18, 2017 · 03d440e · 03d440e
1 parent 16e3cf6
commit 03d440e
Showing 1 changed file with 13 additions and 0 deletions.
diff --git 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