aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/read-file/arraybuffer.md
blob: 149b08d8eb0a30638b820a52e5f5f0a81aac58cd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
---
name: Read a file to an ArrayBuffer
---

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 `.arrayBuffer()` to read the file as an `ArrayBuffer`.

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

const buffer = await file.arrayBuffer();
```

---

The binary content in the `ArrayBuffer` can then be read as a typed array, such as `Uint8Array`.

```ts
const buffer = await file.arrayBuffer();
const bytes = new Uint8Array(buffer);

bytes[0];
bytes.length;
```

---

Refer to the [Typed arrays](/docs/api/binary-data#typedarray) docs for more information on working with typed arrays in Bun.