Files
bun.sh/docs/guides/read-file/uint8array.md
Meghan Denny 5caca9cd48 add .bytes() method to various readables (#11104)
Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
Co-authored-by: nektro <nektro@users.noreply.github.com>
2024-05-16 19:10:50 -07:00

22 lines
685 B
Markdown

---
name: Read a file to a Uint8Array
---
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 `Uint8Array` instance, retrieve the contents of the `BunFile` with `.bytes()`.
```ts
const path = "/path/to/package.json";
const file = Bun.file(path);
const byteArray = await file.bytes();
byteArray[0]; // first byteArray
byteArray.length; // length of byteArray
```
---
Refer to [API > Binary data > Typed arrays](/docs/api/binary-data#typedarray) for more information on working with `Uint8Array` and other binary data formats in Bun.