Skip to content

Commit 03d440e

Browse files
committed
doc: document buffer.buffer property
Buffer objects expose the underlying `Uint8Array`'s `buffer` property by default. This patch formally documents it. PR-URL: #8332 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
1 parent 16e3cf6 commit 03d440e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/api/buffer.md

+13
Original file line numberDiff line numberDiff line change
@@ -879,6 +879,19 @@ for (let i = 0; i < str.length ; i++) {
879879
console.log(buf.toString('ascii'));
880880
```
881881

882+
### buf.buffer
883+
884+
The `buffer` property references the underlying `ArrayBuffer` object based on
885+
which this Buffer object is created.
886+
887+
```js
888+
const arrayBuffer = new ArrayBuffer(16);
889+
const buffer = Buffer.from(arrayBuffer);
890+
891+
console.log(buffer.buffer === arrayBuffer);
892+
// Prints: true
893+
```
894+
882895
### buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])
883896
<!-- YAML
884897
added: v0.11.13

0 commit comments

Comments
 (0)