bun-types
Version:
Type definitions and documentation for Bun, an incredibly fast JavaScript runtime
22 lines (14 loc) • 699 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](https://bun.sh/docs/api/binary-data#typedarray) for more information on working with `Uint8Array` and other binary data formats in Bun.