bun-types 0.1.4 → 0.1.10

package/README.md

@@ -0,0 +1,54 @@
+# Bun TypeScript type definitions
+
+<p align="center">
+  <a href="https://bun.sh"><img src="https://bun.sh/logo@2x.png" alt="Logo"></a>
+</p>
+
+These are the type definitions for Bun's JavaScript runtime APIs.
+
+# Installation
+
+Install the `bun-types` npm package:
+
+```bash
+# 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`:
+
+```jsonc
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "esnext",
+    // "bun-types" is the important part
+    "types": ["bun-types"]
+  }
+}
+```
+
+# Contributing
+
+`bun-types` is generated via [./bundle.ts](./scripts/bundle.ts).
+
+## Adding a new file
+
+1. Add it to [./index.d.ts](./index.d.ts)
+
+## How to generate types.d.ts
+
+[`./bundle.ts`](./bundle.ts) merges the types in this folder into a single file.
+
+To run it:
+
+```bash
+bun generate:package
+```
+
+# Generated docs
+
+**[📚 See here for docs](https://oven-sh.github.io/bun-types/)**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-types",
-  "version": "0.1.4",
+  "version": "0.1.10",
   "description": "Type definitions for bun.js",
   "types": "types.d.ts",
   "files": [
@@ -12,6 +12,6 @@
     "bun.js",
     "types"
   ],
-  "repository": "https://github.com/oven-sh/bun",
+  "repository": "https://github.com/oven-sh/bun-types",
   "homepage": "https://bun.sh"
 }