mirror of
https://github.com/oven-sh/bun
synced 2026-02-11 19:38:58 +00:00
TypeScript types for Bun
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:
{
+ "types": ["bun-types"],
// other options...
}
Contributing
bun-types is generated via ./scripts/bundle.ts.
To add a new file, add it under packages/bun-types. Then add a triple-slash directive pointing to it inside ./index.d.ts.
+ /// <reference path="./newfile.d.ts" />
./bundle.ts merges the types in this folder into a single file. To run it:
bun build