bun-types 1.3.3-canary.20251111T140653 → 1.3.3-canary.20251113T140630

package/docs/quickstart.mdx

@@ -12,198 +12,204 @@ Build a minimal HTTP server with `Bun.serve`, run it locally, then evolve it by
 ---
 
 <Steps>
-	<Step title="Step 1">
-		Initialize a new project with `bun init`.
-
-    	```bash terminal icon="terminal"
-    	bun init my-app
-    	```
-
-    	It'll prompt you to pick a template, either `Blank`, `React`, or `Library`. For this guide, we'll pick `Blank`.
-
-    	```bash terminal icon="terminal"
-    	bun init my-app
-    	```
-    	```txt
-    	✓ Select a project template: Blank
-
-- .gitignore
-- CLAUDE.md
-- .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc -> CLAUDE.md
-- index.ts
-- tsconfig.json (for editor autocomplete)
-- README.md
-
-  ````
-
-      	This automatically creates a `my-app` directory with a basic Bun app.
-      </Step>
-      <Step title="Step 2">
-
-      	Run the `index.ts` file using `bun run index.ts`.
-
-      	```bash terminal icon="terminal"
-      	cd my-app
-      	bun run index.ts
-      	```
-      	```txt
-      Hello via Bun!
-      	```
-
-      	You should see a console output saying `"Hello via Bun!"`.
-      </Step>
-      <Step title="Step 3">
-      	Replace the contents of `index.ts` with the following code:
-
-      	```ts index.ts icon="/icons/typescript.svg"
-      	const server = Bun.serve({
-      		port: 3000,
-      		routes: {
-      			"/": () => new Response('Bun!'),
-      		}
-      	});
-
-      	console.log(`Listening on ${server.url}`);
-      	```
-
-      	Run the `index.ts` file again using `bun run index.ts`.
-
-      	```bash terminal icon="terminal"
-      	bun run index.ts
-      	```
-      	```txt
-      	Listening on http://localhost:3000
-      	```
-
-      	Visit [`http://localhost:3000`](http://localhost:3000) to test the server. You should see a simple page that says `"Bun!"`.
-
-
-      	<Accordion title="Seeing TypeScript errors on Bun?">
-      		If you used `bun init`, Bun will have automatically installed Bun's TypeScript declarations and configured your `tsconfig.json`. If you're trying out Bun in an existing project, you may see a type error on the `Bun` global.
-
-      		To fix this, first install `@types/bun` as a dev dependency.
-
-      		```bash terminal icon="terminal"
-      		bun add -d @types/bun
-      		```
-
-      		Then add the following to your `compilerOptions` in `tsconfig.json`:
-
-      		```json tsconfig.json icon="file-code"
-      		{
-      			"compilerOptions": {
-      				"lib": ["ESNext"],
-      				"target": "ESNext",
-      				"module": "Preserve",
-      				"moduleDetection": "force",
-      				"moduleResolution": "bundler",
-      				"allowImportingTsExtensions": true,
-      				"verbatimModuleSyntax": true,
-      				"noEmit": true
-      			}
-      		}
-      		```
-
-      	</Accordion>
-
-      </Step>
-      <Step title="Step 4">
-      	Install the `figlet` package and its type declarations. Figlet is a utility for converting strings into ASCII art.
-
-      	```bash terminal icon="terminal"
-      	bun add figlet
-      	bun add -d @types/figlet # TypeScript users only
-      	```
-
-      	Update `index.ts` to use `figlet` in `routes`.
-
-      	```ts index.ts icon="/icons/typescript.svg"
-      	import figlet from 'figlet'; // [!code ++]
-
-      	const server = Bun.serve({
-      		port: 3000,
-      		routes: {
-      			"/": () => new Response('Bun!'),
-      			"/figlet": () => { // [!code ++]
-      				const body = figlet.textSync('Bun!'); // [!code ++]
-      				return new Response(body); // [!code ++]
-      			} // [!code ++]
-      		}
-      	});
-
-      	console.log(`Listening on ${server.url}`);
-      	```
-
-      	Run the `index.ts` file again using `bun run index.ts`.
-
-      	```bash terminal icon="terminal"
-      	bun run index.ts
-      	```
-      	```txt
-      	Listening on http://localhost:3000
-      	```
-
-      	Visit [`http://localhost:3000/figlet`](http://localhost:3000/figlet) to test the server. You should see a simple page that says `"Bun!"` in ASCII art.
-
-      	```txt
-      	 ____              _
-      	| __ ) _   _ _ __ | |
-      	|  _ \| | | | '_ \| |
-      	| |_) | |_| | | | |_|
-      	|____/ \__,_|_| |_(_)
-      	```
-      </Step>
-      <Step title="Step 5">
-      	Let's add some HTML. Create a new file called `index.html` and add the following code:
-
-      	```html index.html icon="file-code"
-      	<!DOCTYPE html>
-      	<html lang="en">
-      		<head>
-      			<meta charset="UTF-8">
-      			<meta name="viewport" content="width=device-width, initial-scale=1.0">
-      			<title>Bun</title>
-      		</head>
-      		<body>
-      			<h1>Bun!</h1>
-      		</body>
-      	</html>
-      	```
-
-      	Then, import this file in `index.ts` and serve it from the root `/` route.
-
-      	```ts index.ts icon="/icons/typescript.svg"
-      	import figlet from 'figlet';
-      	import index from './index.html'; // [!code ++]
-
-      	const server = Bun.serve({
-      		port: 3000,
-      		routes: {
-      			"/": index, // [!code ++]
-      			"/figlet": () => {
-      				const body = figlet.textSync('Bun!');
-      				return new Response(body);
-      			}
-      		}
-      	});
-
-      	console.log(`Listening on ${server.url}`);
-      	```
-
-      	Run the `index.ts` file again using `bun run index.ts`.
-
-      	```bash terminal icon="terminal"
-      	bun run index.ts
-      	```
-      	```txt
-      	Listening on http://localhost:3000
-      	```
-
-      	Visit [`http://localhost:3000`](http://localhost:3000) to test the server. You should see the static HTML page.
-      </Step>
-
-  </Steps>
-  ````
+  <Step title="Step 1">
+
+    Initialize a new project with `bun init`.
+
+    ```bash terminal icon="terminal"
+    bun init my-app
+    ```
+
+    It'll prompt you to pick a template, either `Blank`, `React`, or `Library`. For this guide, we'll pick `Blank`.
+
+    ```bash terminal icon="terminal"
+    bun init my-app
+    ```
+    ```txt
+    ✓ Select a project template: Blank
+
+    - .gitignore
+    - CLAUDE.md
+    - .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc -> CLAUDE.md
+    - index.ts
+    - tsconfig.json (for editor autocomplete)
+    - README.md
+    ```
+
+    This automatically creates a `my-app` directory with a basic Bun app.
+
+  </Step>
+  <Step title="Step 2">
+
+    Run the `index.ts` file using `bun run index.ts`.
+
+    ```bash terminal icon="terminal"
+    cd my-app
+    bun run index.ts
+    ```
+    ```txt
+    Hello via Bun!
+    ```
+
+    You should see a console output saying `"Hello via Bun!"`.
+
+  </Step>
+  <Step title="Step 3">
+
+    Replace the contents of `index.ts` with the following code:
+
+    ```ts index.ts icon="/icons/typescript.svg"
+    const server = Bun.serve({
+      port: 3000,
+      routes: {
+        "/": () => new Response('Bun!'),
+      }
+    });
+
+    console.log(`Listening on ${server.url}`);
+    ```
+
+    Run the `index.ts` file again using `bun run index.ts`.
+
+    ```bash terminal icon="terminal"
+    bun run index.ts
+    ```
+    ```txt
+    Listening on http://localhost:3000
+    ```
+
+    Visit [`http://localhost:3000`](http://localhost:3000) to test the server. You should see a simple page that says `"Bun!"`.
+
+    <Accordion title="Seeing TypeScript errors on Bun?">
+
+      If you used `bun init`, Bun will have automatically installed Bun's TypeScript declarations and configured your `tsconfig.json`. If you're trying out Bun in an existing project, you may see a type error on the `Bun` global.
+
+      To fix this, first install `@types/bun` as a dev dependency.
+
+      ```bash terminal icon="terminal"
+      bun add -d @types/bun
+      ```
+
+      Then add the following to your `compilerOptions` in `tsconfig.json`:
+
+      ```json tsconfig.json icon="file-code"
+      {
+        "compilerOptions": {
+          "lib": ["ESNext"],
+          "target": "ESNext",
+          "module": "Preserve",
+          "moduleDetection": "force",
+          "moduleResolution": "bundler",
+          "allowImportingTsExtensions": true,
+          "verbatimModuleSyntax": true,
+          "noEmit": true
+        }
+      }
+      ```
+
+    </Accordion>
+
+  </Step>
+  <Step title="Step 4">
+
+    Install the `figlet` package and its type declarations. Figlet is a utility for converting strings into ASCII art.
+
+    ```bash terminal icon="terminal"
+    bun add figlet
+    bun add -d @types/figlet # TypeScript users only
+    ```
+
+    Update `index.ts` to use `figlet` in `routes`.
+
+    ```ts index.ts icon="/icons/typescript.svg"
+    import figlet from 'figlet'; // [!code ++]
+
+    const server = Bun.serve({
+      port: 3000,
+      routes: {
+        "/": () => new Response('Bun!'),
+        "/figlet": () => { // [!code ++]
+          const body = figlet.textSync('Bun!'); // [!code ++]
+          return new Response(body); // [!code ++]
+        } // [!code ++]
+      }
+    });
+
+    console.log(`Listening on ${server.url}`);
+    ```
+
+    Run the `index.ts` file again using `bun run index.ts`.
+
+    ```bash terminal icon="terminal"
+    bun run index.ts
+    ```
+    ```txt
+    Listening on http://localhost:3000
+    ```
+
+    Visit [`http://localhost:3000/figlet`](http://localhost:3000/figlet) to test the server. You should see a simple page that says `"Bun!"` in ASCII art.
+
+    ```txt
+    ____              _
+    | __ ) _   _ _ __ | |
+    |  _ \| | | | '_ \| |
+    | |_) | |_| | | | |_|
+    |____/ \__,_|_| |_(_)
+    ```
+
+  </Step>
+  <Step title="Step 5">
+
+    Let's add some HTML. Create a new file called `index.html` and add the following code:
+
+    ```html index.html icon="file-code"
+    <!DOCTYPE html>
+    <html lang="en">
+      <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Bun</title>
+      </head>
+      <body>
+        <h1>Bun!</h1>
+      </body>
+    </html>
+    ```
+
+    Then, import this file in `index.ts` and serve it from the root `/` route.
+
+    ```ts index.ts icon="/icons/typescript.svg"
+    import figlet from 'figlet';
+    import index from './index.html'; // [!code ++]
+
+    const server = Bun.serve({
+      port: 3000,
+      routes: {
+        "/": index, // [!code ++]
+        "/figlet": () => {
+          const body = figlet.textSync('Bun!');
+          return new Response(body);
+        }
+      }
+    });
+
+    console.log(`Listening on ${server.url}`);
+    ```
+
+    Run the `index.ts` file again using `bun run index.ts`.
+
+    ```bash terminal icon="terminal"
+    bun run index.ts
+    ```
+    ```txt
+    Listening on http://localhost:3000
+    ```
+
+    Visit [`http://localhost:3000`](http://localhost:3000) to test the server. You should see the static HTML page.
+
+  </Step>
+
+</Steps>
 
 🎉 Congratulations! You've built a simple HTTP server with Bun and installed a package.
 
@@ -234,7 +240,7 @@ bun run start
 ```
 
 ```txt
- Listening on http://localhost:3000
+Listening on http://localhost:3000
 ```
 
 <Note>⚡️ **Performance** — `bun run` is roughly 28x faster than `npm run` (6ms vs 170ms of overhead).</Note>

package/docs/runtime/bunfig.mdx

@@ -401,6 +401,7 @@ Environment variable: `BUN_INSTALL_BIN`
 
 ```toml title="bunfig.toml" icon="settings"
 # where globally-installed package bins are linked
+[install]
 globalBinDir = "~/.bun/bin"
 ```
 

package/docs/runtime/module-resolution.mdx

@@ -276,7 +276,7 @@ await Bun.build({
 
 ## Path re-mapping
 
-In the spirit of treating TypeScript as a first-class citizen, the Bun runtime will re-map import paths according to the [`compilerOptions.paths`](https://www.typescriptlang.org/tsconfig#paths) field in `tsconfig.json`. This is a major divergence from Node.js, which doesn't support any form of import path re-mapping.
+Bun supports import path re-mapping through TypeScript's [`compilerOptions.paths`](https://www.typescriptlang.org/tsconfig#paths) in `tsconfig.json`, which works well with editors. If you aren't a TypeScript user, you can achieve the same behavior by using a [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) in your project root.
 
 ```json tsconfig.json icon="file-json"
 {
@@ -289,7 +289,16 @@ In the spirit of treating TypeScript as a first-class citizen, the Bun runtime w
 }
 ```
 
-If you aren't a TypeScript user, you can create a [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) in your project root to achieve the same behavior.
+Bun also supports [Node.js-style subpath imports](https://nodejs.org/api/packages.html#subpath-imports) in `package.json`, where mapped paths must start with `#`. This approach doesn’t work as well with editors, but both options can be used together.
+
+```json package.json icon="file-json"
+{
+  "imports": {
+    "#config": "./config.ts", // map specifier to file
+    "#components/*": "./components/*" // wildcard matching
+  }
+}
+```
 
 <Accordion title="Low-level details of CommonJS interop in Bun">
 

package/docs/runtime/networking/dns.mdx

@@ -23,7 +23,7 @@ dns.prefetch("bun.com", 443);
 
 ## DNS caching in Bun
 
-In Bun v1.1.9, we added support for DNS caching. This cache makes repeated connections to the same hosts faster.
+Bun supports DNS caching. This cache makes repeated connections to the same hosts faster.
 
 At the time of writing, we cache up to 255 entries for a maximum of 30 seconds (each). If any connections to a host fail, we remove the entry from the cache. When multiple connections are made to the same host simultaneously, DNS lookups are deduplicated to avoid making multiple requests for the same host.
 

package/docs/runtime/plugins.mdx

@@ -42,7 +42,21 @@ type PluginBuilder = {
   config: BuildConfig;
 };
 
-type Loader = "js" | "jsx" | "ts" | "tsx" | "css" | "json" | "toml";
+type Loader =
+  | "js"
+  | "jsx"
+  | "ts"
+  | "tsx"
+  | "json"
+  | "jsonc"
+  | "toml"
+  | "yaml"
+  | "file"
+  | "napi"
+  | "wasm"
+  | "text"
+  | "css"
+  | "html";
 ```
 
 ## Usage

package/docs/runtime/s3.mdx

@@ -697,7 +697,7 @@ To list some or all (up to 1,000) objects in a bucket, you can use the `S3Client
 ```ts s3.ts icon="/icons/typescript.svg" highlight={12, 15-20, 24-29}
 import { S3Client } from "bun";
 
-const credentials = { ... }
+const credentials = {
   accessKeyId: "your-access-key",
   secretAccessKey: "your-secret-key",
   bucket: "my-bucket",

package/docs/runtime/sqlite.mdx

@@ -359,8 +359,6 @@ for (const row of query) {
 }
 ```
 
-This feature was added in Bun v1.1.31.
-
 ### `.values()`
 
 Use `values()` to run a query and get back all results as an array of arrays.

package/docs/runtime/workers.mdx

@@ -76,11 +76,9 @@ const worker = new Worker("./worker.ts", {
 });
 ```
 
-This feature was added in Bun v1.1.35.
-
 ### `blob:` URLs
 
-As of Bun v1.1.13, you can also pass a `blob:` URL to `Worker`. This is useful for creating workers from strings or other sources.
+You can also pass a `blob:` URL to `Worker`. This is useful for creating workers from strings or other sources.
 
 ```js
 const blob = new Blob(

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.3-canary.20251111T140653",
+  "version": "1.3.3-canary.20251113T140630",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",