mirror of https://github.com/oven-sh/bun synced 2026-02-15 21:32:05 +00:00

Files

Jarred Sumner d615c11a57 Force non-zero exit code whenever bun install has any packages which failed to install (#10041 )

* If any failed to install, always exit with non-zero

* [autofix.ci] apply automated fixes

* This test should fail

* Update bun-link.test.ts

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

2024-04-07 16:12:16 -07:00

scripts

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

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

test

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

2024-01-25 19:15:26 -08: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

Force non-zero exit code whenever bun install has any packages which failed to install (#10041 )

2024-04-07 16:12:16 -07:00

bun.lockb

Update lockfiles

2024-03-20 09:16:01 -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

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

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

globals.d.ts

feat(runtime): align import.meta.resolve with node.js's implementation (#5827 )

2024-04-01 02:21:34 -07: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

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

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

overrides.d.ts

Merge conflict fix

2024-04-05 15:41:45 -07:00

package.json

Use biome in bun-types

2024-02-05 12:22:39 -08:00

README.md

Better types (#7670 )

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

sqlite.d.ts

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

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

test.d.ts

add test.todoIf and fix bun-install-registry.test.ts on windows (#9723 )

2024-03-30 21:25:05 -07: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