mirror of https://github.com/oven-sh/bun synced 2026-02-09 10:28:47 +00:00

Files

Alistair Smith 4117af6e46 feat(vscode-extension) error reporting, qol (#15261 )

Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
Co-authored-by: Ashcon Partovi <ashcon@partovi.net>
Co-authored-by: Electroid <Electroid@users.noreply.github.com>
Co-authored-by: Meghan Denny <meghan@bun.sh>
Co-authored-by: Dylan Conway <dylan.conway567@gmail.com>

2024-11-22 02:55:21 -08:00

scripts

use Biome to format Bun's codebase instead of Prettier (#8494 )

2024-01-25 19:15:26 -08:00

test

WIP: nuke EventSource as it doesn't work anyway (#14421 )

2024-10-14 19:55:06 -07:00

.eslintignore

Add bun-types, add typechecking, add child_process types (#1475 )

2022-11-09 15:40:40 -08:00

.eslintrc.cjs

Better types (#7670 )

2023-12-18 13:27:48 -08:00

.gitignore

Add bun-types, add typechecking, add child_process types (#1475 )

2022-11-09 15:40:40 -08:00

.prettierignore

Add bun-types, add typechecking, add child_process types (#1475 )

2022-11-09 15:40:40 -08:00

bun.d.ts

feat(vscode-extension) error reporting, qol (#15261 )

2024-11-22 02:55:21 -08:00

bun.lockb

Remove util.styleText type overrides because @types/node has them now (#10746 )

2024-05-01 12:53:08 -07:00

deprecated.d.ts

use Biome to format Bun's codebase instead of Prettier (#8494 )

2024-01-25 19:15:26 -08:00

fetch.d.ts

use Biome to format Bun's codebase instead of Prettier (#8494 )

2024-01-25 19:15:26 -08:00

ffi.d.ts

Update ffi.d.ts

2024-09-20 00:07:26 -07:00

globals.d.ts

Support preload option in Worker (#15045 )

2024-11-07 21:30:51 -08:00

html-rewriter.d.ts

use Biome to format Bun's codebase instead of Prettier (#8494 )

2024-01-25 19:15:26 -08:00

index.d.ts

Fix bun-types/index.d.ts (#8802 )

2024-02-09 08:46:42 -08:00

jsc.d.ts

Support promises in profile method in bun:jsc (#12165 )

2024-07-06 20:24:21 -07:00

overrides.d.ts

run prettier and add back format action (#13722 )

2024-09-03 21:32:52 -07:00

package.json

Remove util.styleText type overrides because @types/node has them now (#10746 )

2024-05-01 12:53:08 -07:00

README.md

Better types (#7670 )

2023-12-18 13:27:48 -08:00

sqlite.d.ts

Some types and docs

2024-10-12 06:19:46 -07:00

test.d.ts

Fix docs on todo tests (#15233 )

2024-11-18 19:28:28 -08:00

tsconfig.json

Better types (#7670 )

2023-12-18 13:27:48 -08:00

wasm.d.ts

use Biome to format Bun's codebase instead of Prettier (#8494 )

2024-01-25 19:15:26 -08:00

README.md

TypeScript types for Bun

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