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 = file.stream();
The chunks of the stream can be consumed as an async iterable using for await
.
for await (const chunk of stream) {
chunk; // => Uint8Array
}
Refer to the Streams documentation for more information on working with streams in Bun.