aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/binary/arraybuffer-to-buffer.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/binary/arraybuffer-to-buffer.md')
-rw-r--r--docs/guides/binary/arraybuffer-to-buffer.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/guides/binary/arraybuffer-to-buffer.md b/docs/guides/binary/arraybuffer-to-buffer.md
new file mode 100644
index 000000000..2737ebb4e
--- /dev/null
+++ b/docs/guides/binary/arraybuffer-to-buffer.md
@@ -0,0 +1,25 @@
+---
+name: Convert an ArrayBuffer to a Uint8Array
+---
+
+The Node.js [`Buffer`](https://nodejs.org/api/buffer.html) API predates the introduction of `ArrayBuffer` into the JavaScript language. Bun implements both.
+
+Use the static `Buffer.from()` method to create a `Buffer` from an `ArrayBuffer`.
+
+```ts
+const arrBuffer = new ArrayBuffer(64);
+const nodeBuffer = Buffer.from(arrBuffer);
+```
+
+---
+
+To create a `Buffer` that only views a portion of the underlying buffer, pass the offset and length to the constructor.
+
+```ts
+const arrBuffer = new ArrayBuffer(64);
+const nodeBuffer = Buffer.from(arrBuffer, 0, 16); // view first 16 bytes
+```
+
+---
+
+See [Docs > API > Binary Data](/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.