mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
20 lines
718 B
Markdown
20 lines
718 B
Markdown
---
|
|
name: Read a file to a Buffer
|
|
---
|
|
|
|
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.
|
|
|
|
To read the file into a `Buffer` instance, first use `.arrayBuffer()` to consume the file as an `ArrayBuffer`, then use `Buffer.from()` to create a `Buffer` from the `ArrayBuffer`.
|
|
|
|
```ts
|
|
const path = "/path/to/package.json";
|
|
const file = Bun.file(path);
|
|
|
|
const arrbuf = await file.arrayBuffer();
|
|
const buffer = Buffer.from(arrbuf);
|
|
```
|
|
|
|
---
|
|
|
|
Refer to [Binary data > Buffer](https://bun.com/docs/api/binary-data#buffer) for more information on working with `Buffer` and other binary data formats in Bun.
|