aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/read-file/uint8array.md
blob: 1afcaa79711f98dabfbbd583db0e1ecf547c5bd5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
---
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` as an `ArrayBuffer` with `.arrayBuffer()`, then pass it into the `Uint8Array` constructor.

```ts
const path = "/path/to/package.json";
const file = Bun.file(path);

const arrBuffer = await file.arrayBuffer();
const byteArray = new Uint8Array(arrBuffer);

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.