bun-types 1.3.2-canary.20251106T140813 → 1.3.2-canary.20251108T140624

package/docs/guides/ecosystem/qwik.mdx

@@ -0,0 +1,114 @@
+---
+title: Build an app with Qwik and Bun
+sidebarTitle: Qwik with Bun
+mode: center
+---
+
+Initialize a new Qwik app with `bunx create-qwik`.
+
+The `create-qwik` package detects when you are using `bunx` and will automatically install dependencies using `bun`.
+
+```sh terminal icon="terminal"
+bun create qwik
+```
+
+```txts
+      ............
+    .::: :--------:.
+   .::::  .:-------:.
+  .:::::.   .:-------.
+  ::::::.     .:------.
+ ::::::.        :-----:
+ ::::::.       .:-----.
+  :::::::.     .-----.
+   ::::::::..   ---:.
+    .:::::::::. :-:.
+     ..::::::::::::
+             ...::::
+
+
+┌  Let's create a  Qwik App  ✨ (v1.2.10)
+│
+◇  Where would you like to create your new project? (Use '.' or './' for current directory)
+│  ./my-app
+│
+●  Creating new project in  /path/to/my-app  ... 🐇
+│
+◇  Select a starter
+│  Basic App
+│
+◇  Would you like to install bun dependencies?
+│  Yes
+│
+◇  Initialize a new git repository?
+│  No
+│
+◇  Finishing the install. Wanna hear a joke?
+│  Yes
+│
+○  ────────────────────────────────────────────────────────╮
+│                                                          │
+│  How do you know if there’s an elephant under your bed?  │
+│  Your head hits the ceiling!                             │
+│                                                          │
+├──────────────────────────────────────────────────────────╯
+│
+◇  App Created 🐰
+│
+◇  Installed bun dependencies 📋
+│
+○  Result ─────────────────────────────────────────────╮
+│                                                      │
+│  Success!  Project created in my-app directory       │
+│                                                      │
+│  Integrations? Add Netlify, Cloudflare, Tailwind...  │
+│  bun qwik add                                        │
+│                                                      │
+│  Relevant docs:                                      │
+│  https://qwik.builder.io/docs/getting-started/       │
+│                                                      │
+│  Questions? Start the conversation at:               │
+│  https://qwik.builder.io/chat                        │
+│  https://twitter.com/QwikDev                         │
+│                                                      │
+│  Presentations, Podcasts and Videos:                 │
+│  https://qwik.builder.io/media/                      │
+│                                                      │
+│  Next steps:                                         │
+│  cd my-app                                           │
+│  bun start                                           │
+│                                                      │
+│                                                      │
+├──────────────────────────────────────────────────────╯
+│
+└  Happy coding! 🎉
+
+```
+
+---
+
+Run `bun run dev` to start the development server.
+
+```sh terminal icon="terminal"
+bun run dev
+```
+
+```txt
+$ vite--mode ssr
+
+VITE v4.4.7  ready in 1190 ms
+
+➜  Local:   http://localhost:5173/
+➜  Network: use --host to expose
+➜  press h to show help
+```
+
+---
+
+Open [http://localhost:5173](http://localhost:5173) with your browser to see the result. Qwik will hot-reload your app as you edit your source files.
+
+<Frame>![Qwik screenshot](https://github.com/oven-sh/bun/assets/3084745/ec35f2f7-03dd-4c90-851e-fb4ad150bb28)</Frame>
+
+---
+
+Refer to the [Qwik docs](https://qwik.builder.io/docs/getting-started/) for complete documentation.

package/docs/guides/ecosystem/react.mdx

@@ -0,0 +1,52 @@
+---
+title: Build a React app with Bun
+sidebarTitle: React with Bun
+mode: center
+---
+
+Bun supports `.jsx` and `.tsx` files out of the box. React just works with Bun.
+
+Create a new React app with `bun init --react`. This gives you a template with a simple React app and a simple API server together in one full-stack app.
+
+```bash terminal icon="terminal"
+# Create a new React app
+bun init --react
+
+# Run the app in development mode
+bun dev
+
+# Build as a static site for production
+bun run build
+
+# Run the server in production
+bun start
+```
+
+---
+
+### Hot Reloading
+
+Run `bun dev` to start the app in development mode. This will start the API server and the React app with hot reloading.
+
+### Full-Stack App
+
+Run `bun start` to start the API server and frontend together in one process.
+
+### Static Site
+
+Run `bun run build` to build the app as a static site. This will create a `dist` directory with the built app and all the assets.
+
+```txt File Tree icon="folder-tree"
+├── src/
+│   ├── index.tsx       # Server entry point with API routes
+│   ├── frontend.tsx    # React app entry point with HMR
+│   ├── App.tsx         # Main React component
+│   ├── APITester.tsx   # Component for testing API endpoints
+│   ├── index.html      # HTML template
+│   ├── index.css       # Styles
+│   └── *.svg           # Static assets
+├── package.json        # Dependencies and scripts
+├── tsconfig.json       # TypeScript configuration
+├── bunfig.toml         # Bun configuration
+└── bun.lock            # Lock file
+```

package/docs/guides/ecosystem/remix.mdx

@@ -0,0 +1,97 @@
+---
+title: Build an app with Remix and Bun
+sidebarTitle: Remix with Bun
+mode: center
+---
+
+<Note>
+  Currently the Remix development server (`remix dev`) relies on Node.js APIs that Bun does not yet implement. The guide
+  below uses Bun to initialize a project and install dependencies, but it uses Node.js to run the dev server.
+</Note>
+
+---
+
+Initialize a Remix app with `create-remix`.
+
+```sh terminal icon="terminal"
+bun create remix
+```
+
+```txt
+ remix   v1.19.3 💿 Let's build a better website...
+
+   dir   Where should we create your new project?
+         ./my-app
+
+      ◼  Using basic template See https://remix.run/docs/en/main/guides/templates#templates for more
+      ✔  Template copied
+
+   git   Initialize a new git repository?
+         Yes
+
+  deps   Install dependencies with bun?
+         Yes
+
+      ✔  Dependencies installed
+      ✔  Git initialized
+
+  done   That's it!
+         Enter your project directory using cd ./my-app
+         Check out README.md for development and deploy instructions.
+```
+
+---
+
+To start the dev server, run `bun run dev` from the project root. This will start the dev server using the `remix dev` command. Note that Node.js will be used to run the dev server.
+
+```sh terminal icon="terminal"
+cd my-app
+bun run dev
+```
+
+```txt
+$ remix dev
+
+💿  remix dev
+
+info  building...
+info  built (263ms)
+Remix App Server started at http://localhost:3000 (http://172.20.0.143:3000)
+```
+
+---
+
+Open [http://localhost:3000](http://localhost:3000) to see the app. Any changes you make to `app/routes/_index.tsx` will be hot-reloaded in the browser.
+
+<Frame>
+  ![Remix app running on localhost](https://github.com/oven-sh/bun/assets/3084745/c26f1059-a5d4-4c0b-9a88-d9902472fd77)
+</Frame>
+
+---
+
+To build and start your app, run `bun run build`
+
+```sh terminal icon="terminal"
+bun run build
+```
+
+```txt
+$ remix build
+info  building... (NODE_ENV=production)
+info  built (158ms)
+```
+
+Then `bun run start` from the project root.
+
+```sh terminal icon="terminal"
+bun start
+```
+
+```txt
+$ remix-serve ./build/index.js
+[remix-serve] http://localhost:3000 (http://192.168.86.237:3000)
+```
+
+---
+
+Read the [Remix docs](https://remix.run/) for more information on how to build apps with Remix.

package/docs/guides/ecosystem/sentry.mdx

@@ -0,0 +1,54 @@
+---
+title: Add Sentry to a Bun app
+sidebarTitle: Sentry with Bun
+mode: center
+---
+
+[Sentry](https://sentry.io) is a developer-first error tracking and performance monitoring platform. Sentry has a first-class SDK for Bun, `@sentry/bun`, that instruments your Bun application to automatically collect error and performance data.
+
+Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
+
+---
+
+To start using Sentry with Bun, first install the Sentry Bun SDK.
+
+```sh terminal icon="terminal"
+bun add @sentry/bun
+```
+
+---
+
+Then, initialize the Sentry SDK with your Sentry DSN in your app's entry file. You can find your DSN in your Sentry project settings.
+
+```js sentry.ts icon="/icons/typescript.svg"
+import * as Sentry from "@sentry/bun";
+
+// Ensure to call this before importing any other modules!
+Sentry.init({
+  dsn: "__SENTRY_DSN__",
+
+  // Add Performance Monitoring by setting tracesSampleRate
+  // We recommend adjusting this value in production
+  tracesSampleRate: 1.0,
+});
+```
+
+---
+
+You can verify that Sentry is working by capturing a test error:
+
+```js sentry.ts icon="/icons/typescript.svg"
+setTimeout(() => {
+  try {
+    foo();
+  } catch (e) {
+    Sentry.captureException(e);
+  }
+}, 99);
+```
+
+To view and resolve the recorded error, log into [sentry.io](https://sentry.io/) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
+
+---
+
+To learn more about Sentry and using the Sentry Bun SDK, view the [Sentry documentation](https://docs.sentry.io/platforms/javascript/guides/bun).

package/docs/guides/ecosystem/solidstart.mdx

@@ -0,0 +1,66 @@
+---
+title: Build an app with SolidStart and Bun
+sidebarTitle: "SolidStart with Bun"
+mode: center
+---
+
+<Warning>
+  SolidStart currently relies on Node.js APIs that Bun does not yet implement. The guide below uses Bun to initialize a
+  project and install dependencies, but it uses Node.js to run the dev server.
+</Warning>
+
+---
+
+Initialize a SolidStart app with `create-solid`.
+
+```sh terminal icon="terminal"
+bun create solid my-app
+```
+
+```txt
+create-solid version 0.2.31
+
+Welcome to the SolidStart setup wizard!
+
+There are definitely bugs and some feature might not work yet.
+If you encounter an issue, have a look at
+https://github.com/solidjs/solid-start/issues and open a new one,
+if it is not already tracked.
+
+✔ Which template do you want to use? › todomvc
+✔ Server Side Rendering? … yes
+✔ Use TypeScript? … yes
+cloned solidjs/solid-start#main to /path/to/my-app/.solid-start
+✔ Copied project files
+```
+
+---
+
+As instructed by the `create-solid` CLI, let's install our dependencies.
+
+```sh terminal icon="terminal"
+cd my-app
+bun install
+```
+
+---
+
+Then run the development server.
+
+```sh terminal icon="terminal"
+bun run dev
+# or, equivalently
+bunx solid-start dev
+```
+
+---
+
+Open [localhost:3000](http://localhost:3000). Any changes you make to `src/routes/index.tsx` will be hot-reloaded automatically.
+
+<Frame>
+  ![SolidStart demo app](https://github.com/oven-sh/bun/assets/3084745/1e8043c4-49d1-498c-9add-c1eaab6c7167)
+</Frame>
+
+---
+
+Refer to the [SolidStart website](https://start.solidjs.com/getting-started/what-is-solidstart) for complete framework documentation.

package/docs/guides/ecosystem/ssr-react.mdx

@@ -0,0 +1,49 @@
+---
+title: Server-side render (SSR) a React component
+sidebarTitle: "SSR React with Bun"
+mode: center
+---
+
+To get started, install `react` & `react-dom`:
+
+```sh terminal icon="terminal"
+# Any package manager can be used
+bun add react react-dom
+```
+
+---
+
+To render a React component to an HTML stream server-side (SSR):
+
+```tsx ssr-react.tsx icon="file-code"
+import { renderToReadableStream } from "react-dom/server";
+
+function Component(props: { message: string }) {
+  return (
+    <body>
+      <h1>{props.message}</h1>
+    </body>
+  );
+}
+
+const stream = await renderToReadableStream(<Component message="Hello from server!" />);
+```
+
+---
+
+Combining this with `Bun.serve()`, we get a simple SSR HTTP server:
+
+```tsx server.ts icon="/icons/typescript.svg"
+Bun.serve({
+  async fetch() {
+    const stream = await renderToReadableStream(<Component message="Hello from server!" />);
+    return new Response(stream, {
+      headers: { "Content-Type": "text/html" },
+    });
+  },
+});
+```
+
+---
+
+React `19` and later includes an [SSR optimization](https://github.com/facebook/react/pull/25597) that takes advantage of Bun's "direct" `ReadableStream` implementation. If you run into an error like `export named 'renderToReadableStream' not found`, please make sure to install version `19` of `react` & `react-dom`, or import from `react-dom/server.browser` instead of `react-dom/server`. See [facebook/react#28941](https://github.com/facebook/react/issues/28941) for more information.

package/docs/guides/ecosystem/stric.mdx

@@ -0,0 +1,54 @@
+---
+title: Build an HTTP server using StricJS and Bun
+sidebarTitle: "StricJS with Bun"
+mode: center
+---
+
+[StricJS](https://github.com/bunsvr) is a Bun framework for building high-performance web applications and APIs.
+
+- **Fast** — Stric is one of the fastest Bun frameworks. See [benchmark](https://github.com/bunsvr/benchmark) for more details.
+- **Minimal** — The basic components like `@stricjs/router` and `@stricjs/utils` are under 50kB and require no external dependencies.
+- **Extensible** — Stric includes with a plugin system, dependency injection, and optional optimizations for handling requests.
+
+---
+
+Use `bun init` to create an empty project.
+
+```bash terminal icon="terminal"
+mkdir myapp
+cd myapp
+bun init
+bun add @stricjs/router @stricjs/utils
+```
+
+---
+
+To implement a simple HTTP server with StricJS:
+
+```ts index.ts icon="file-code"
+import { Router } from "@stricjs/router";
+
+export default new Router().get("/", () => new Response("Hi"));
+```
+
+---
+
+To serve static files from `/public`:
+
+```ts index.ts icon="file-code"
+import { dir } from "@stricjs/utils";
+
+export default new Router().get("/", () => new Response("Hi")).get("/*", dir("./public"));
+```
+
+---
+
+Run the file in watch mode to start the development server.
+
+```bash terminal icon="terminal"
+bun --watch run index.ts
+```
+
+---
+
+For more info, see Stric's [documentation](https://stricjs.netlify.app).

package/docs/guides/ecosystem/sveltekit.mdx

@@ -0,0 +1,138 @@
+---
+title: Build an app with SvelteKit and Bun
+sidebarTitle: "SvelteKit with Bun"
+mode: center
+---
+
+Use `sv create my-app` to create a SvelteKit project with SvelteKit CLI. Answer the prompts to select a template and set up your development environment.
+
+```sh terminal icon="terminal"
+bunx sv create my-app
+```
+
+```txt
+┌  Welcome to the Svelte CLI! (v0.5.7)
+│
+◇  Which template would you like?
+│  SvelteKit demo
+│
+◇  Add type checking with Typescript?
+│  Yes, using Typescript syntax
+│
+◆  Project created
+│
+◇  What would you like to add to your project?
+│  none
+│
+◇  Which package manager do you want to install dependencies with?
+│  bun
+│
+◇  Successfully installed dependencies
+│
+◇  Project next steps ─────────────────────────────────────────────────────╮
+│                                                                          │
+│  1: cd my-app                                                            │
+│  2: git init && git add -A && git commit -m "Initial commit" (optional)  │
+│  3: bun run dev -- --open                                                │
+│                                                                          │
+│  To close the dev server, hit Ctrl-C                                     │
+│                                                                          │
+│  Stuck? Visit us at https://svelte.dev/chat                              │
+│                                                                          │
+├──────────────────────────────────────────────────────────────────────────╯
+│
+└  You're all set!
+```
+
+---
+
+Once the project is initialized, `cd` into the new project. You don't need to run 'bun install' since the dependencies are already installed.
+
+Then start the development server with `bun --bun run dev`.
+
+To run the dev server with Node.js instead of Bun, you can omit the `--bun` flag.
+
+```sh terminal icon="terminal"
+cd my-app
+bun --bun run dev
+```
+
+```txt
+  $ vite dev
+  Forced re-optimization of dependencies
+
+    VITE v5.4.10  ready in 424 ms
+
+    ➜  Local:   http://localhost:5173/
+    ➜  Network: use --host to expose
+    ➜  press h + enter to show help
+```
+
+---
+
+Visit [http://localhost:5173](http://localhost:5173/) in a browser to see the template app.
+
+<Frame>
+  ![SvelteKit app running](https://github.com/oven-sh/bun/assets/3084745/7c76eae8-78f9-44fa-9f15-1bd3ca1a47c0)
+</Frame>
+
+---
+
+If you edit and save `src/routes/+page.svelte`, you should see your changes hot-reloaded in the browser.
+
+---
+
+To build for production, you'll need to add the right SvelteKit adapter. Currently we recommend the
+
+`bun add -D svelte-adapter-bun`.
+
+Now, make the following changes to your `svelte.config.js`.
+
+```ts svelte.config.js icon="file-code"
+import adapter from "@sveltejs/adapter-auto"; // [!code --]
+import adapter from "svelte-adapter-bun"; // [!code ++]
+import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+  // Consult https://svelte.dev/docs/kit/integrations#preprocessors
+  // for more information about preprocessors
+  preprocess: vitePreprocess(),
+
+  kit: {
+    // adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
+    // If your environment is not supported, or you settled on a specific environment, switch out the adapter.
+    // See https://svelte.dev/docs/kit/adapters for more information about adapters.
+    adapter: adapter(),
+  },
+};
+
+export default config;
+```
+
+---
+
+To build a production bundle:
+
+```sh terminal icon="terminal"
+bun --bun run build
+```
+
+```txt
+  $ vite build
+  vite v5.4.10 building SSR bundle for production...
+  "confetti" is imported from external module "@neoconfetti/svelte" but never used in "src/routes/sverdle/+page.svelte".
+  ✓ 130 modules transformed.
+  vite v5.4.10 building for production...
+  ✓ 148 modules transformed.
+  ...
+  ✓ built in 231ms
+  ...
+  ✓ built in 899ms
+
+  Run npm run preview to preview your production build locally.
+
+  > Using svelte-adapter-bun
+    ✔ Start server with: bun ./build/index.js
+    ✔ done
+```