bun-types
TypeScript icon, indicating that this package has built-in type declarations

1.1.4 • Public • Published

TypeScript types for Bun

Logo

These are the type definitions for Bun's JavaScript runtime APIs.

Installation

Install the @types/bun npm package:

# yarn/npm/pnpm work too
# @types/bun is an ordinary npm package
bun add -D @types/bun

That's it! VS Code and TypeScript automatically load @types/* packages into your project, so the Bun global and all bun:* modules should be available immediately.

Contributing

The @types/bun package is a shim that loads bun-types. The bun-types package lives in the Bun repo under packages/bun-types. It 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

Readme

Keywords

Package Sidebar

Install

npm i bun-types

Homepage

bun.sh

Weekly Downloads

261,523

Version

1.1.4

License

MIT

Unpacked Size

352 kB

Total Files

14

Last publish

Collaborators

  • colinmcd94
  • jarred
  • robobun