bun-types 1.0.18 → 1.0.19

package/README.md

@@ -8,31 +8,19 @@ These are the type definitions for Bun's JavaScript runtime APIs.
 
 # Installation
 
-Install the `bun-types` npm package:
+Install the `@types/bun` npm package:
 
 ```bash
-# yarn/npm/pnpm work too, "bun-types" is an ordinary npm package
-bun add -d bun-types
+# yarn/npm/pnpm work too
+# @types/bun is an ordinary npm package
+bun add -D @types/bun
 ```
 
-# Usage
-
-Add this to your `tsconfig.json` or `jsconfig.json`:
-
-```jsonc-diff
-  {
-    "compilerOptions": {
-+     "types": ["bun-types"]
-      // other options...
-    }
-
-    // other options...
-  }
-```
+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
 
-`bun-types` is generated via [./scripts/bundle.ts](./scripts/bundle.ts).
+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](./scripts/bundle.ts).
 
 To add a new file, add it under `packages/bun-types`. Then add a [triple-slash directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) pointing to it inside [./index.d.ts](./index.d.ts).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-types",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "license": "MIT",
   "description": "Type definitions for Bun, an incredibly fast JavaScript runtime",
   "types": "types.d.ts",
@@ -16,5 +16,10 @@
     "types"
   ],
   "repository": "https://github.com/oven-sh/bun",
-  "homepage": "https://bun.sh"
+  "homepage": "https://bun.sh",
+  "dependencies": {
+    "@types/node": "*",
+    "@types/ws": "*",
+    "undici-types": "^5.26.4"
+  }
 }

package/tsconfig.json

@@ -17,9 +17,6 @@
     "composite": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "allowJs": true,
-    "types": [
-      "bun-types"
-    ]
+    "allowJs": true
   }
 }