Replace old docs with new docs repo (#24201)

This commit is contained in:
Lydia Hallie
2025-11-05 11:14:21 -08:00
committed by GitHub
parent 550522e99b
commit 1606a9f24e
407 changed files with 21970 additions and 17527 deletions

View 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.