blob: 3b7488472bf348a4f94b45c7e6e6eee7ac41a66e (
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
29
30
31
32
33
34
|
---
name: Read a JSON file
---
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 `.json()` to read and parse the contents of a `.json` file as a plain object.
```ts
const path = "/path/to/package.json";
const file = Bun.file(path);
const contents = await file.json();
// { name: "my-package" }
```
---
The MIME type of the `BunFile` will be set accordingly.
```ts
const path = "/path/to/package.json";
const file = Bun.file(path);
file.type; // => "application/json;charset=utf-8";
```
---
If the path to the `.json` file is static, it can be directly imported as a module.
```ts
import pkg from "./package.json";
pkg.name; // => "my-package"
```
|
