mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
27 lines
832 B
Markdown
27 lines
832 B
Markdown
---
|
|
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 = 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.
|