Files
bun.sh/docs/guides/read-file/stream.md
Colin McDonnell 4c89c60867 Add files (#3826)
2023-07-26 14:59:39 -07:00

673 B

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

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.

for await (const chunk of stream.values()) {
  chunk; // => Uint8Array
}

Refer to the Streams documentation for more information on working with streams in Bun.