From 03d440e3ced202221e6b95b718d35941af25b16f Mon Sep 17 00:00:00 2001 From: "Sakthipriyan Vairamani (thefourtheye)" Date: Wed, 11 Jan 2017 00:55:48 +0530 Subject: [PATCH] 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 Reviewed-By: Trevor Norris --- doc/api/buffer.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 227e5257ead15a..d506cc1a1173b8 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]]]])