diff options
author | 2023-07-26 14:59:39 -0700 | |
---|---|---|
committer | 2023-07-26 14:59:39 -0700 | |
commit | 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 (patch) | |
tree | fc1d2f47309c0345a850933496baa40d94bfdcbb /docs/guides/read-file/stream.md | |
parent | 6bfee02301a2e2a0b79339974af0445eb5a2688f (diff) | |
download | bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.gz bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.zst bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.zip |
Add files (#3826)
Diffstat (limited to 'docs/guides/read-file/stream.md')
-rw-r--r-- | docs/guides/read-file/stream.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/guides/read-file/stream.md b/docs/guides/read-file/stream.md new file mode 100644 index 000000000..6b88c3672 --- /dev/null +++ b/docs/guides/read-file/stream.md @@ -0,0 +1,26 @@ +--- +name: Read a file as a ReadableStream +--- + +The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.stream()` to consume the file incrementally as a `ReadableStream`. + +```ts +const path = "/path/to/package.json"; +const file = Bun.file(path); + +const stream = await file.stream(); +``` + +--- + +The chunks of the stream can be consumed with `for await`. + +```ts +for await (const chunk of stream.values()) { + chunk; // => Uint8Array +} +``` + +--- + +Refer to the [Streams](/docs/api/streams) documentation for more information on working with streams in Bun. |