bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/guides/deployment/{railway.md → railway.mdx}

@@ -1,6 +1,8 @@
 ---
-name: Deploy a Bun application on Railway
+title: Deploy a Bun application on Railway
 description: Deploy Bun applications to Railway with this step-by-step guide covering CLI and dashboard methods, optional PostgreSQL setup, and automatic SSL configuration.
+sidebarTitle: Deploy on Railway
+mode: center
 ---
 
 Railway is an infrastructure platform where you can provision infrastructure, develop with that infrastructure locally, and then deploy to the cloud. It enables instant deployments from GitHub with zero configuration, automatic SSL, and built-in database provisioning.
@@ -9,14 +11,13 @@ This guide walks through deploying a Bun application with a PostgreSQL database
 
 You can either follow this guide step-by-step or simply deploy the pre-configured template with one click:
 
-{% raw %}
-
-<a href="https://railway.com/deploy/bun-react-postgres?referralCode=Bun&utm_medium=integration&utm_source=template&utm_campaign=bun" target="_blank">
+<a
+  href="https://railway.com/deploy/bun-react-postgres?referralCode=Bun&utm_medium=integration&utm_source=template&utm_campaign=bun"
+  target="_blank"
+>
   <img src="https://railway.com/button.svg" alt="Deploy on Railway" />
 </a>
 
-{% /raw %}
-
 ---
 
 **Prerequisites**:
@@ -30,88 +31,78 @@ You can either follow this guide step-by-step or simply deploy the pre-configure
 
 ## Method 1: Deploy via CLI
 
----
-
-#### Step 1
-
+<Steps>
+<Step title="Step 1">
 Ensure sure you have the Railway CLI installed.
 
-```bash
+```bash terminal icon="terminal"
 bun install -g @railway/cli
 ```
 
----
-
-#### Step 2
-
+</Step>
+<Step title="Step 2">
 Log into your Railway account.
 
-```bash
+```bash terminal icon="terminal"
 railway login
 ```
 
----
-
-#### Step 3
-
+</Step>
+<Step title="Step 3">
 After successfully authenticating, initialize a new project.
 
-```bash
-# Initialize project
-bun-react-postgres$ railway init
+```bash terminal icon="terminal"
+railway init
 ```
 
----
-
-#### Step 4
-
+</Step>
+<Step title="Step 4">
 After initializing the project, add a new database and service.
 
-> **Note:** Step 4 is only necessary if your application uses a database. If you don't need PostgreSQL, skip to Step 5.
+<Note>Step 4 is only necessary if your application uses a database. If you don't need PostgreSQL, skip to Step 5.</Note>
 
-```bash
+```bash terminal icon="terminal"
 # Add PostgreSQL database. Make sure to add this first!
-bun-react-postgres$ railway add --database postgres
+railway add --database postgres
 
 # Add your application service.
-bun-react-postgres$ railway add --service bun-react-db --variables DATABASE_URL=\${{Postgres.DATABASE_URL}}
+railway add --service bun-react-db --variables DATABASE_URL=\${{Postgres.DATABASE_URL}}
 ```
 
----
-
-#### Step 5
-
+</Step>
+<Step title="Step 5">
 After the services have been created and connected, deploy the application to Railway. By default, services are only accessible within Railway's private network. To make your app publicly accessible, you need to generate a public domain.
 
-```bash
+```bash terminal icon="terminal"
 # Deploy your application
-bun-nextjs-starter$ railway up
+railway up
 
 # Generate public domain
-bun-nextjs-starter$ railway domain
+railway domain
 ```
 
----
+</Step>
+</Steps>
 
-## Method 2: Deploy via Dashboard
+Your app is now live! Railway auto-deploys on every GitHub push.
 
 ---
 
-#### Step 1
+## Method 2: Deploy via Dashboard
 
+<Steps>
+<Step title="Step 1">
 Create a new project
 
 1. Go to [Railway Dashboard](http://railway.com/dashboard?utm_medium=integration&utm_source=docs&utm_campaign=bun)
 2. Click **"+ New"** → **"GitHub repo"**
 3. Choose your repository
 
----
-
-#### Step 2
-
+</Step>
+<Step title="Step 2">
 Add a PostgreSQL database, and connect this database to the service
 
-> **Note:** Step 2 is only necessary if your application uses a database. If you don't need PostgreSQL, skip to Step 3.
+<Note>Step 2 is only necessary if your application uses a database. If you don't need PostgreSQL, skip to Step 3.</Note>
 
 1. Click **"+ New"** → **"Database"** → **"Add PostgreSQL"**
 2. After the database has been created, select your service (not the database)
@@ -119,17 +110,16 @@ Add a PostgreSQL database, and connect this database to the service
 4. Click **"+ New Variable"** → **"Add Reference"**
 5. Select `DATABASE_URL` from postgres
 
----
-
-#### Step 3
-
+</Step>
+<Step title="Step 3">
 Generate a public domain
 
 1. Select your service
 2. Go to **"Settings"** tab
 3. Under **"Networking"**, click **"Generate Domain"**
 
----
+</Step>
+</Steps>
 
 Your app is now live! Railway auto-deploys on every GitHub push.
 
@@ -137,15 +127,13 @@ Your app is now live! Railway auto-deploys on every GitHub push.
 
 ## Configuration (Optional)
 
----
-
 By default, Railway uses [Nixpacks](https://docs.railway.com/guides/build-configuration#nixpacks-options) to automatically detect and build your Bun application with zero configuration.
 
 However, using the [Railpack](https://docs.railway.com/guides/build-configuration#railpack) application builder provides better Bun support, and will always support the latest version of Bun. The pre-configured templates use Railpack by default.
 
 To enable Railpack in a custom project, add the following to your `railway.json`:
 
-```json
+```json railway.json icon="file-json"
 {
   "$schema": "https://railway.com/railway.schema.json",
   "build": {

package/docs/guides/deployment/render.mdx

@@ -0,0 +1,82 @@
+---
+title: Deploy a Bun application on Render
+sidebarTitle: Deploy on Render
+mode: center
+---
+
+[Render](https://render.com/) is a cloud platform that lets you flexibly build, deploy, and scale your apps.
+
+It offers features like auto deploys from GitHub, a global CDN, private networks, automatic HTTPS setup, and managed PostgreSQL and Redis.
+
+Render supports Bun natively. You can deploy Bun apps as web services, background workers, cron jobs, and more.
+
+---
+
+As an example, let's deploy a simple Express HTTP server to Render.
+
+<Steps>
+	<Step title="Step 1">
+		Create a new GitHub repo named `myapp`. Git clone it locally.
+
+    	```sh
+    	git clone git@github.com:my-github-username/myapp.git
+    	cd myapp
+    	```
+    	</Step>
+    	<Step title="Step 2">
+    	Add the Express library.
+
+    	```sh
+    	bun add express
+    	```
+
+    </Step>
+
+    <Step title="Step 3">
+    	Define a simple server with Express:
+
+    	```ts app.ts icon="/icons/typescript.svg"
+    	import express from "express";
+
+    	const app = express();
+    	const port = process.env.PORT || 3001;
+
+    	app.get("/", (req, res) => {
+    		res.send("Hello World!");
+    	});
+
+    	app.listen(port, () => {
+    		console.log(`Listening on port ${port}...`);
+    	});
+    	```
+    </Step>
+    <Step title="Step 4">
+
+    	Commit your changes and push to GitHub.
+
+    	```sh terminal icon="terminal"
+    	git add app.ts bun.lock package.json
+    	git commit -m "Create simple Express app"
+    	git push origin main
+    	```
+    </Step>
+    <Step title="Step 5">
+    	In your [Render Dashboard](https://dashboard.render.com/), click `New` > `Web Service` and connect your `myapp` repo.
+
+    </Step>
+    <Step title="Step 6">
+    	In the Render UI, provide the following values during web service creation:
+
+    	|                   |               |
+    	| ----------------- | ------------- |
+    	| **Runtime**       | `Node`        |
+    	| **Build Command** | `bun install` |
+    	| **Start Command** | `bun app.ts`  |
+
+    </Step>
+
+</Steps>
+
+That's it! Your web service will be live at its assigned `onrender.com` URL as soon as the build finishes.
+
+You can view the [deploy logs](https://docs.render.com/logging#logs-for-an-individual-deploy-or-job) for details. Refer to [Render's documentation](https://docs.render.com/deploys) for a complete overview of deploying on Render.

package/docs/guides/deployment/vercel.mdx

@@ -0,0 +1,99 @@
+---
+title: Deploy a Bun application on Vercel
+sidebarTitle: Deploy on Vercel
+mode: center
+---
+
+import { ProductCard } from "/snippets/product-card.mdx";
+
+[Vercel](https://vercel.com/) is a cloud platform that lets you build, deploy, and scale your apps.
+
+<Warning>
+  The Bun runtime is in Beta; certain features (e.g., automatic source maps, byte-code caching, metrics on
+  `node:http/https`) are not yet supported.
+</Warning>
+
+<Note>
+  `Bun.serve` is currently not supported on Vercel Functions. Use Bun with frameworks supported by Vercel, like Next.js,
+  Express, Hono, or Nitro.
+</Note>
+
+---
+
+<Steps>
+	<Step title="Configure Bun in vercel.json">
+		To enable the Bun runtime for your Functions, add a `bunVersion` field in your `vercel.json` file:
+
+    	```json vercel.json icon="file-json"
+    	{
+    		"bunVersion": "1.x" // [!code ++]
+    	}
+    	```
+
+    	Vercel automatically detects this configuration and runs your application on Bun. The value has to be `"1.x"`, Vercel handles the minor version internally.
+
+    	For best results, match your local Bun version with the version used by Vercel. **Currently, Bun version `1.2.23` is supported**.
+    </Step>
+
+    <Step title="Next.js configuration">
+    	If you’re deploying a **Next.js** project (including ISR), update your `package.json` scripts to use the Bun runtime:
+
+    	```json package.json icon="file-json"
+    	{
+    		"scripts": {
+    			"dev": "bun --bun next dev", // [!code ++]
+    			"build": "bun --bun next build" // [!code ++]
+    		}
+    	}
+    	```
+
+    	<Note>
+    		The `--bun` flag runs the Next.js CLI under Bun. Bundling (via Turbopack or Webpack) remains unchanged, but all commands execute within the Bun runtime.
+    	</Note>
+
+    	This ensures both local development and builds use Bun.
+    </Step>
+
+    <Step title="Deploy your app">
+    	Connect your repository to Vercel, or deploy from the CLI:
+
+    	```bash terminal icon="terminal"
+    	# Using bunx (no global install)
+    	bunx vercel login
+    	bunx vercel deploy
+    	```
+
+    	Or install the Vercel CLI globally:
+
+    	```bash terminal icon="terminal"
+    	bun i -g vercel
+    	vercel login
+    	vercel deploy
+    	```
+
+    	[Learn more in the Vercel Deploy CLI documentation →](https://vercel.com/docs/cli/deploy)
+    </Step>
+
+    <Step title="Verify the runtime">
+    	To confirm your deployment uses Bun, log the Bun version:
+
+    	```ts index.ts icon="/icons/typescript.svg"
+    	console.log("runtime", process.versions.bun);
+    	```
+    	```txt
+    	runtime 1.2.23
+    	```
+
+    	[See the Vercel Bun Runtime documentation for feature support →](https://vercel.com/docs/functions/runtimes/bun#feature-support)
+    </Step>
+
+</Steps>
+
+---
+
+- [Fluid compute](https://vercel.com/docs/fluid-compute): Both Bun and Node.js runtimes run on Fluid compute and support the same core Vercel Functions features.
+- [Middleware](https://vercel.com/docs/routing-middleware): To run Routing Middleware with Bun, set the runtime to `nodejs`:
+
+```ts middleware.ts icon="/icons/typescript.svg"
+export const config = { runtime: "nodejs" }; // [!code ++]
+```

package/docs/guides/ecosystem/{astro.md → astro.mdx}

@@ -1,11 +1,16 @@
 ---
-name: Build an app with Astro and Bun
+title: Build an app with Astro and Bun
+sidebarTitle: "Astro with Bun"
+mode: center
 ---
 
 Initialize a fresh Astro app with `bun create astro`. The `create-astro` package detects when you are using `bunx` and will automatically install dependencies using `bun`.
 
-```sh
-$ bun create astro
+```sh terminal icon="terminal"
+bun create astro
+```
+
+```txt
 ╭─────╮  Houston:
 │ ◠ ◡ ◠  We're glad to have you on board.
 ╰─────╯
@@ -53,8 +58,11 @@ Start the dev server with `bunx`.
 
 By default, Bun will run the dev server with Node.js. To use the Bun runtime instead, use the `--bun` flag.
 
-```sh
-$ bunx --bun astro dev
+```sh terminal icon="terminal"
+bunx --bun astro dev
+```
+
+```txt
   🚀  astro  v3.1.4 started in 200ms
 
   ┃ Local    http://localhost:4321/
@@ -65,7 +73,9 @@ $ bunx --bun astro dev
 
 Open [http://localhost:4321](http://localhost:4321) with your browser to see the result. Astro will hot-reload your app as you edit your source files.
 
-{% image src="https://i.imgur.com/Dswiu6w.png" caption="An Astro v3 starter app running on Bun" %}
+<Frame>
+  <img src="https://i.imgur.com/Dswiu6w.png" caption="An Astro v3 starter app running on Bun" />
+</Frame>
 
 ---
 

package/docs/guides/ecosystem/{discordjs.md → discordjs.mdx}

@@ -1,21 +1,23 @@
 ---
-name: Create a Discord bot
+title: Create a Discord bot
+sidebarTitle: "Discord.js with Bun"
+mode: center
 ---
 
 Discord.js works out of the box with Bun. Let's write a simple bot. First create a directory and initialize it with `bun init`.
 
-```sh
-$ mkdir my-bot
-$ cd my-bot
-$ bun init
+```sh terminal icon="terminal"
+mkdir my-bot
+cd my-bot
+bun init
 ```
 
 ---
 
 Now install Discord.js.
 
-```sh
-$ bun add discord.js
+```sh terminal icon="terminal"
+bun add discord.js
 ```
 
 ---
@@ -26,11 +28,9 @@ Before we go further, we need to go to the [Discord developer portal](https://di
 
 Once complete, you'll be presented with your bot's _private key_. Let's add this to a file called `.env.local`. Bun automatically reads this file and loads it into `process.env`.
 
-{% callout %}
-This is an example token that has already been invalidated.
-{% /callout %}
+<Note>This is an example token that has already been invalidated.</Note>
 
-```txt#.env.local
+```txt .env.local icon="settings"
 DISCORD_TOKEN=NzkyNzE1NDU0MTk2MDg4ODQy.X-hvzA.Ovy4MCQywSkoMRRclStW4xAYK7I
 ```
 
@@ -38,7 +38,7 @@ DISCORD_TOKEN=NzkyNzE1NDU0MTk2MDg4ODQy.X-hvzA.Ovy4MCQywSkoMRRclStW4xAYK7I
 
 Be sure to add `.env.local` to your `.gitignore`! It is dangerous to check your bot's private key into version control.
 
-```txt#.gitignore
+```txt .gitignore icon="file-code"
 node_modules
 .env.local
 ```
@@ -47,15 +47,15 @@ node_modules
 
 Now let's actually write our bot in a new file called `bot.ts`.
 
-```ts#bot.ts
+```ts bot.ts icon="/icons/typescript.svg"
 // import discord.js
-import {Client, Events, GatewayIntentBits} from 'discord.js';
+import { Client, Events, GatewayIntentBits } from "discord.js";
 
 // create a new Client instance
-const client = new Client({intents: [GatewayIntentBits.Guilds]});
+const client = new Client({ intents: [GatewayIntentBits.Guilds] });
 
 // listen for the client to be ready
-client.once(Events.ClientReady, (c) => {
+client.once(Events.ClientReady, c => {
   console.log(`Ready! Logged in as ${c.user.tag}`);
 });
 
@@ -67,8 +67,11 @@ client.login(process.env.DISCORD_TOKEN);
 
 Now we can run our bot with `bun run`. It may take a several seconds for the client to initialize the first time you run the file.
 
-```sh
-$ bun run bot.ts
+```sh terminal icon="terminal"
+bun run bot.ts
+```
+
+```txt
 Ready! Logged in as my-bot#1234
 ```
 

package/docs/guides/ecosystem/{docker.md → docker.mdx}

@@ -1,10 +1,12 @@
 ---
-name: Containerize a Bun application with Docker
+title: Containerize a Bun application with Docker
+sidebarTitle: Docker with Bun
+mode: center
 ---
 
-{% callout %}
-This guide assumes you already have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
-{% /callout %}
+<Note>
+  This guide assumes you already have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
+</Note>
 
 [Docker](https://www.docker.com) is a platform for packaging and running an application as a lightweight, portable _container_ that encapsulates all the necessary dependencies.
 
@@ -12,7 +14,7 @@ This guide assumes you already have [Docker Desktop](https://www.docker.com/prod
 
 To _containerize_ our application, we define a `Dockerfile`. This file contains a list of instructions to initialize the container, copy our local project files into it, install dependencies, and starts the application.
 
-```docker#Dockerfile
+```docker Dockerfile icon="docker"
 # use the official Bun image
 # see all versions at https://hub.docker.com/r/oven/bun/tags
 FROM oven/bun:1 AS base
@@ -57,7 +59,7 @@ ENTRYPOINT [ "bun", "run", "index.ts" ]
 
 Now that you have your docker image, let's look at `.dockerignore` which has the same syntax as `.gitignore`, here you need to specify the files/directories that must not go in any stage of the docker build. An example for a ignore file is
 
-```txt#.dockerignore
+```txt .dockerignore icon="docker"
 node_modules
 Dockerfile*
 docker-compose*
@@ -81,8 +83,11 @@ We'll now use `docker build` to convert this `Dockerfile` into a _Docker image_,
 
 The `-t` flag lets us specify a name for the image, and `--pull` tells Docker to automatically download the latest version of the base image (`oven/bun`). The initial build will take longer, as Docker will download all the base images and dependencies.
 
-```bash
-$ docker build --pull -t bun-hello-world .
+```bash terminal icon="terminal"
+docker build --pull -t bun-hello-world .
+```
+
+```txt
 [+] Building 0.9s (21/21) FINISHED
  => [internal] load build definition from Dockerfile                                                                                     0.0s
  => => transferring dockerfile: 37B                                                                                                      0.0s
@@ -108,8 +113,11 @@ We'll use `docker run` to start a new container using the `bun-hello-world` imag
 
 The `run` command prints a string representing the _container ID_.
 
-```sh
-$ docker run -d -p 3000:3000 bun-hello-world
+```sh terminal icon="terminal"
+docker run -d -p 3000:3000 bun-hello-world
+```
+
+```txt
 7f03e212a15ede8644379bce11a13589f563d3909a9640446c5bbefce993678d
 ```
 
@@ -121,16 +129,19 @@ The container is now running in the background. Visit [localhost:3000](http://lo
 
 To stop the container, we'll use `docker stop <container-id>`.
 
-```sh
-$ docker stop 7f03e212a15ede8644379bce11a13589f563d3909a9640446c5bbefce993678d
+```sh terminal icon="terminal"
+docker stop 7f03e212a15ede8644379bce11a13589f563d3909a9640446c5bbefce993678d
 ```
 
 ---
 
 If you can't find the container ID, you can use `docker ps` to list all running containers.
 
-```sh
-$ docker ps
+```sh terminal icon="terminal"
+docker ps
+```
+
+```txt
 CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS                    NAMES
 7f03e212a15e        bun-hello-world     "bun run index.ts"       2 minutes ago       Up 2 minutes        0.0.0.0:3000->3000/tcp   flamboyant_cerf
 ```