mirror of
https://github.com/oven-sh/bun
synced 2026-02-13 12:29:07 +00:00
742368f03a
* WIP * Update types * Spacing --------- Co-authored-by: Colin McDonnell <colinmcd@alum.mit.edu>
Bun TypeScript type definitions
These are the type definitions for Bun's JavaScript runtime APIs.
Installation
Install the bun-types npm package:
# yarn/npm/pnpm work too, "bun-types" is an ordinary npm package
bun add bun-types
Usage
Add this to your tsconfig.json or jsconfig.json:
{
"compilerOptions": {
"lib": ["ESNext"],
"module": "ESNext",
"target": "ESNext",
"moduleResolution": "Node",
// "bun-types" is the important part
"types": ["bun-types"]
}
}
Contributing
bun-types is generated via ./bundle.ts.
Adding a new file
- Add it to ./index.d.ts
How to generate types.d.ts
./bundle.ts merges the types in this folder into a single file.
To run it:
bun build