]> zoso.dev Git - buffer.git/commitdiff
Add slice for converting to ArrayBuffer
authorSam Sudar <sudar.sam@gmail.com>
Sat, 1 Jul 2017 05:14:16 +0000 (22:14 -0700)
committerSam Sudar <sudar.sam@gmail.com>
Sat, 1 Jul 2017 05:14:16 +0000 (22:14 -0700)
The .buffer property is an ArrayBuffer, but it is not necessarily the
same length as the original buffer. This adds further documentation to
the README to flesh out converting a Buffer to an ArrayBuffer.

README.md

index 6acfd222eafd4361c31d8224963b439033cd4d42..e92510072019c2229aebb997654b94c54a00bf70 100644 (file)
--- a/README.md
+++ b/README.md
@@ -138,9 +138,13 @@ var buffer = Buffer.from(arrayBuffer)
 To convert a `Buffer` to an `ArrayBuffer`, use the `.buffer` property (which is present on all `Uint8Array` objects):
 
 ```js
-var arrayBuffer = buffer.buffer
+var arrayBuffer = buffer.buffer.slice(
+  buffer.byteOffset, buffer.byteOffset + buffer.byteLength
+)
 ```
 
+Alternatively, use the [`to-arraybuffer`](https://www.npmjs.com/package/to-arraybuffer) module.
+
 ## performance
 
 See perf tests in `/perf`.