bun-types
Version:
Type definitions and documentation for Bun, an incredibly fast JavaScript runtime
18 lines (12 loc) • 538 B
Markdown
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.
The MIME type of the `BunFile` will be set accordingly.
```ts
const path = "/path/to/package.json";
const file = Bun.file(path);
const contents = await file.json();
// { name: "my-package" }
file.type; // => "application/json;charset=utf-8";
```