mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
Replace old docs with new docs repo (#24201)
This commit is contained in:
28
docs/guides/read-file/stream.mdx
Normal file
28
docs/guides/read-file/stream.mdx
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Read a file as a ReadableStream
|
||||
sidebarTitle: Read as stream
|
||||
mode: center
|
||||
---
|
||||
|
||||
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 = file.stream();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
The chunks of the stream can be consumed as an [async iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols) using `for await`.
|
||||
|
||||
```ts
|
||||
for await (const chunk of stream) {
|
||||
chunk; // => Uint8Array
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Refer to the [Streams](https://bun.com/docs/api/streams) documentation for more information on working with streams in Bun.
|
||||
Reference in New Issue
Block a user