aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/streams/to-buffer.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/streams/to-buffer.md')
-rw-r--r--docs/guides/streams/to-buffer.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/guides/streams/to-buffer.md b/docs/guides/streams/to-buffer.md
new file mode 100644
index 000000000..d6450d644
--- /dev/null
+++ b/docs/guides/streams/to-buffer.md
@@ -0,0 +1,15 @@
+---
+name: Convert a ReadableStream to a Buffer
+---
+
+Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats. This snippet reads the contents of a `ReadableStream` to an [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), then creates a [`Buffer`](https://nodejs.org/api/buffer.html) that points to it.
+
+```ts
+const stream = new ReadableStream();
+const arrBuf = await Bun.readableStreamToArrayBuffer(stream);
+const nodeBuf = Buffer.from(arrBuf);
+```
+
+---
+
+See [Docs > API > Utils](/docs/api/utils#bun-readablestreamto) for documentation on Bun's other `ReadableStream` conversion functions.