npm - bun-types - Versions diffs - 1.3.2-canary.20251105T140650 → 1.3.2-canary.20251106T140813 - Mend

bun-types 1.3.2-canary.20251105T140650 → 1.3.2-canary.20251106T140813

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (308) hide show

package/docs/README.md +28 -0
package/package.json +1 -1
package/docs/api/binary-data.md +0 -1038
package/docs/api/cc.md +0 -197
package/docs/api/color.md +0 -262
package/docs/api/console.md +0 -57
package/docs/api/cookie.md +0 -449
package/docs/api/dns.md +0 -110
package/docs/api/fetch.md +0 -463
package/docs/api/ffi.md +0 -557
package/docs/api/file-io.md +0 -366
package/docs/api/file-system-router.md +0 -112
package/docs/api/file.md +0 -19
package/docs/api/glob.md +0 -178
package/docs/api/globals.md +0 -387
package/docs/api/hashing.md +0 -319
package/docs/api/html-rewriter.md +0 -334
package/docs/api/http.md +0 -1408
package/docs/api/import-meta.md +0 -69
package/docs/api/node-api.md +0 -14
package/docs/api/redis.md +0 -597
package/docs/api/s3.md +0 -850
package/docs/api/secrets.md +0 -319
package/docs/api/semver.md +0 -52
package/docs/api/spawn.md +0 -582
package/docs/api/sql.md +0 -1374
package/docs/api/sqlite.md +0 -694
package/docs/api/streams.md +0 -230
package/docs/api/tcp.md +0 -221
package/docs/api/transpiler.md +0 -276
package/docs/api/udp.md +0 -123
package/docs/api/utils.md +0 -891
package/docs/api/websockets.md +0 -573
package/docs/api/workers.md +0 -322
package/docs/api/yaml.md +0 -668
package/docs/benchmarks.md +0 -120
package/docs/bun-flavored-toml.md +0 -42
package/docs/bundler/css.md +0 -1028
package/docs/bundler/css_modules.md +0 -145
package/docs/bundler/executables.md +0 -626
package/docs/bundler/fullstack.md +0 -418
package/docs/bundler/hmr.md +0 -234
package/docs/bundler/html.md +0 -349
package/docs/bundler/index.md +0 -1735
package/docs/bundler/intro.md +0 -75
package/docs/bundler/loaders.md +0 -410
package/docs/bundler/macros.md +0 -329
package/docs/bundler/plugins.md +0 -449
package/docs/bundler/vs-esbuild.md +0 -1127
package/docs/cli/add.md +0 -173
package/docs/cli/bun-completions.md +0 -3
package/docs/cli/bun-create.md +0 -338
package/docs/cli/bun-install.md +0 -349
package/docs/cli/bun-upgrade.md +0 -39
package/docs/cli/bunx.md +0 -89
package/docs/cli/filter.md +0 -90
package/docs/cli/info.md +0 -65
package/docs/cli/init.md +0 -85
package/docs/cli/install.md +0 -344
package/docs/cli/link.md +0 -40
package/docs/cli/outdated.md +0 -90
package/docs/cli/patch-commit.md +0 -11
package/docs/cli/pm.md +0 -285
package/docs/cli/publish.md +0 -120
package/docs/cli/remove.md +0 -7
package/docs/cli/run.md +0 -261
package/docs/cli/test.md +0 -397
package/docs/cli/unlink.md +0 -9
package/docs/cli/update.md +0 -129
package/docs/cli/why.md +0 -67
package/docs/contributing/upgrading-webkit.md +0 -57
package/docs/ecosystem/elysia.md +0 -24
package/docs/ecosystem/express.md +0 -37
package/docs/ecosystem/hono.md +0 -18
package/docs/ecosystem/react.md +0 -65
package/docs/ecosystem/stric.md +0 -38
package/docs/guides/binary/arraybuffer-to-array.md +0 -27
package/docs/guides/binary/arraybuffer-to-blob.md +0 -24
package/docs/guides/binary/arraybuffer-to-buffer.md +0 -25
package/docs/guides/binary/arraybuffer-to-string.md +0 -15
package/docs/guides/binary/arraybuffer-to-typedarray.md +0 -39
package/docs/guides/binary/blob-to-arraybuffer.md +0 -14
package/docs/guides/binary/blob-to-dataview.md +0 -14
package/docs/guides/binary/blob-to-stream.md +0 -14
package/docs/guides/binary/blob-to-string.md +0 -15
package/docs/guides/binary/blob-to-typedarray.md +0 -14
package/docs/guides/binary/buffer-to-arraybuffer.md +0 -14
package/docs/guides/binary/buffer-to-blob.md +0 -14
package/docs/guides/binary/buffer-to-readablestream.md +0 -41
package/docs/guides/binary/buffer-to-string.md +0 -25
package/docs/guides/binary/buffer-to-typedarray.md +0 -14
package/docs/guides/binary/dataview-to-string.md +0 -15
package/docs/guides/binary/typedarray-to-arraybuffer.md +0 -25
package/docs/guides/binary/typedarray-to-blob.md +0 -16
package/docs/guides/binary/typedarray-to-buffer.md +0 -14
package/docs/guides/binary/typedarray-to-dataview.md +0 -14
package/docs/guides/binary/typedarray-to-readablestream.md +0 -41
package/docs/guides/binary/typedarray-to-string.md +0 -16
package/docs/guides/deployment/railway.md +0 -157
package/docs/guides/ecosystem/astro.md +0 -72
package/docs/guides/ecosystem/discordjs.md +0 -77
package/docs/guides/ecosystem/docker.md +0 -140
package/docs/guides/ecosystem/drizzle.md +0 -185
package/docs/guides/ecosystem/edgedb.md +0 -228
package/docs/guides/ecosystem/elysia.md +0 -31
package/docs/guides/ecosystem/express.md +0 -40
package/docs/guides/ecosystem/hono.md +0 -39
package/docs/guides/ecosystem/mongoose.md +0 -87
package/docs/guides/ecosystem/neon-drizzle.md +0 -220
package/docs/guides/ecosystem/neon-serverless-postgres.md +0 -55
package/docs/guides/ecosystem/nextjs.md +0 -49
package/docs/guides/ecosystem/nuxt.md +0 -56
package/docs/guides/ecosystem/pm2.md +0 -57
package/docs/guides/ecosystem/prisma.md +0 -141
package/docs/guides/ecosystem/qwik.md +0 -107
package/docs/guides/ecosystem/react.md +0 -50
package/docs/guides/ecosystem/remix.md +0 -78
package/docs/guides/ecosystem/render.md +0 -79
package/docs/guides/ecosystem/sentry.md +0 -52
package/docs/guides/ecosystem/solidstart.md +0 -58
package/docs/guides/ecosystem/ssr-react.md +0 -51
package/docs/guides/ecosystem/stric.md +0 -55
package/docs/guides/ecosystem/sveltekit.md +0 -125
package/docs/guides/ecosystem/systemd.md +0 -113
package/docs/guides/ecosystem/vite.md +0 -71
package/docs/guides/html-rewriter/extract-links.md +0 -68
package/docs/guides/html-rewriter/extract-social-meta.md +0 -93
package/docs/guides/http/cluster.md +0 -66
package/docs/guides/http/fetch-unix.md +0 -33
package/docs/guides/http/fetch.md +0 -24
package/docs/guides/http/file-uploads.md +0 -94
package/docs/guides/http/hot.md +0 -26
package/docs/guides/http/proxy.md +0 -24
package/docs/guides/http/server.md +0 -46
package/docs/guides/http/simple.md +0 -18
package/docs/guides/http/stream-file.md +0 -48
package/docs/guides/http/stream-iterator.md +0 -47
package/docs/guides/http/stream-node-streams-in-bun.md +0 -20
package/docs/guides/http/tls.md +0 -30
package/docs/guides/install/add-dev.md +0 -26
package/docs/guides/install/add-git.md +0 -36
package/docs/guides/install/add-optional.md +0 -25
package/docs/guides/install/add-peer.md +0 -43
package/docs/guides/install/add-tarball.md +0 -33
package/docs/guides/install/add.md +0 -42
package/docs/guides/install/azure-artifacts.md +0 -73
package/docs/guides/install/cicd.md +0 -41
package/docs/guides/install/custom-registry.md +0 -30
package/docs/guides/install/from-npm-install-to-bun-install.md +0 -214
package/docs/guides/install/git-diff-bun-lockfile.md +0 -44
package/docs/guides/install/jfrog-artifactory.md +0 -28
package/docs/guides/install/npm-alias.md +0 -23
package/docs/guides/install/registry-scope.md +0 -38
package/docs/guides/install/trusted.md +0 -46
package/docs/guides/install/workspaces.md +0 -70
package/docs/guides/install/yarnlock.md +0 -44
package/docs/guides/process/argv.md +0 -58
package/docs/guides/process/ctrl-c.md +0 -16
package/docs/guides/process/ipc.md +0 -66
package/docs/guides/process/nanoseconds.md +0 -13
package/docs/guides/process/os-signals.md +0 -39
package/docs/guides/process/spawn-stderr.md +0 -31
package/docs/guides/process/spawn-stdout.md +0 -26
package/docs/guides/process/spawn.md +0 -41
package/docs/guides/process/stdin.md +0 -54
package/docs/guides/read-file/arraybuffer.md +0 -28
package/docs/guides/read-file/buffer.md +0 -19
package/docs/guides/read-file/exists.md +0 -16
package/docs/guides/read-file/json.md +0 -17
package/docs/guides/read-file/mime.md +0 -20
package/docs/guides/read-file/stream.md +0 -26
package/docs/guides/read-file/string.md +0 -22
package/docs/guides/read-file/uint8array.md +0 -21
package/docs/guides/read-file/watch.md +0 -68
package/docs/guides/runtime/build-time-constants.md +0 -293
package/docs/guides/runtime/cicd.md +0 -43
package/docs/guides/runtime/codesign-macos-executable.md +0 -56
package/docs/guides/runtime/define-constant.md +0 -145
package/docs/guides/runtime/delete-directory.md +0 -37
package/docs/guides/runtime/delete-file.md +0 -19
package/docs/guides/runtime/heap-snapshot.md +0 -26
package/docs/guides/runtime/import-html.md +0 -15
package/docs/guides/runtime/import-json.md +0 -44
package/docs/guides/runtime/import-toml.md +0 -30
package/docs/guides/runtime/import-yaml.md +0 -102
package/docs/guides/runtime/read-env.md +0 -32
package/docs/guides/runtime/set-env.md +0 -47
package/docs/guides/runtime/shell.md +0 -40
package/docs/guides/runtime/timezone.md +0 -35
package/docs/guides/runtime/tsconfig-paths.md +0 -29
package/docs/guides/runtime/typescript.md +0 -49
package/docs/guides/runtime/vscode-debugger.md +0 -47
package/docs/guides/runtime/web-debugger.md +0 -82
package/docs/guides/streams/node-readable-to-arraybuffer.md +0 -11
package/docs/guides/streams/node-readable-to-blob.md +0 -11
package/docs/guides/streams/node-readable-to-json.md +0 -12
package/docs/guides/streams/node-readable-to-string.md +0 -12
package/docs/guides/streams/node-readable-to-uint8array.md +0 -11
package/docs/guides/streams/to-array.md +0 -14
package/docs/guides/streams/to-arraybuffer.md +0 -14
package/docs/guides/streams/to-blob.md +0 -14
package/docs/guides/streams/to-buffer.md +0 -15
package/docs/guides/streams/to-json.md +0 -14
package/docs/guides/streams/to-string.md +0 -14
package/docs/guides/streams/to-typedarray.md +0 -22
package/docs/guides/test/bail.md +0 -22
package/docs/guides/test/coverage-threshold.md +0 -60
package/docs/guides/test/coverage.md +0 -44
package/docs/guides/test/happy-dom.md +0 -68
package/docs/guides/test/migrate-from-jest.md +0 -143
package/docs/guides/test/mock-clock.md +0 -48
package/docs/guides/test/mock-functions.md +0 -68
package/docs/guides/test/rerun-each.md +0 -14
package/docs/guides/test/run-tests.md +0 -111
package/docs/guides/test/skip-tests.md +0 -39
package/docs/guides/test/snapshot.md +0 -95
package/docs/guides/test/spy-on.md +0 -46
package/docs/guides/test/svelte-test.md +0 -120
package/docs/guides/test/testing-library.md +0 -92
package/docs/guides/test/timeout.md +0 -15
package/docs/guides/test/todo-tests.md +0 -67
package/docs/guides/test/update-snapshots.md +0 -46
package/docs/guides/test/watch-mode.md +0 -19
package/docs/guides/util/base64.md +0 -15
package/docs/guides/util/deep-equals.md +0 -39
package/docs/guides/util/deflate.md +0 -18
package/docs/guides/util/detect-bun.md +0 -23
package/docs/guides/util/entrypoint.md +0 -17
package/docs/guides/util/escape-html.md +0 -22
package/docs/guides/util/file-url-to-path.md +0 -14
package/docs/guides/util/gzip.md +0 -18
package/docs/guides/util/hash-a-password.md +0 -54
package/docs/guides/util/import-meta-dir.md +0 -13
package/docs/guides/util/import-meta-file.md +0 -13
package/docs/guides/util/import-meta-path.md +0 -13
package/docs/guides/util/javascript-uuid.md +0 -23
package/docs/guides/util/main.md +0 -32
package/docs/guides/util/path-to-file-url.md +0 -14
package/docs/guides/util/sleep.md +0 -22
package/docs/guides/util/version.md +0 -21
package/docs/guides/util/which-path-to-executable-bin.md +0 -15
package/docs/guides/websocket/compression.md +0 -31
package/docs/guides/websocket/context.md +0 -77
package/docs/guides/websocket/pubsub.md +0 -41
package/docs/guides/websocket/simple.md +0 -33
package/docs/guides/write-file/append.md +0 -52
package/docs/guides/write-file/basic.md +0 -44
package/docs/guides/write-file/blob.md +0 -28
package/docs/guides/write-file/cat.md +0 -17
package/docs/guides/write-file/file-cp.md +0 -16
package/docs/guides/write-file/filesink.md +0 -52
package/docs/guides/write-file/response.md +0 -17
package/docs/guides/write-file/stdout.md +0 -21
package/docs/guides/write-file/stream.md +0 -17
package/docs/guides/write-file/unlink.md +0 -16
package/docs/index.md +0 -77
package/docs/install/audit.md +0 -57
package/docs/install/cache.md +0 -59
package/docs/install/catalogs.md +0 -298
package/docs/install/index.md +0 -248
package/docs/install/isolated.md +0 -197
package/docs/install/lifecycle.md +0 -46
package/docs/install/lockfile.md +0 -58
package/docs/install/npmrc.md +0 -105
package/docs/install/overrides.md +0 -73
package/docs/install/patch.md +0 -59
package/docs/install/registries.md +0 -30
package/docs/install/security-scanner-api.md +0 -81
package/docs/install/workspaces.md +0 -114
package/docs/installation.md +0 -327
package/docs/project/asan.md +0 -124
package/docs/project/benchmarking.md +0 -203
package/docs/project/bindgen.md +0 -225
package/docs/project/building-windows.md +0 -162
package/docs/project/contributing.md +0 -347
package/docs/project/internals/build-process-for-ci.md +0 -75
package/docs/project/licensing.md +0 -73
package/docs/project/roadmap.md +0 -87
package/docs/quickstart.md +0 -157
package/docs/runtime/autoimport.md +0 -94
package/docs/runtime/bun-apis.md +0 -207
package/docs/runtime/bunfig.md +0 -772
package/docs/runtime/debugger.md +0 -325
package/docs/runtime/env.md +0 -253
package/docs/runtime/hot.md +0 -145
package/docs/runtime/index.md +0 -312
package/docs/runtime/jsx.md +0 -385
package/docs/runtime/loaders.md +0 -130
package/docs/runtime/modules.md +0 -320
package/docs/runtime/nodejs-apis.md +0 -463
package/docs/runtime/plugins.md +0 -561
package/docs/runtime/shell.md +0 -605
package/docs/runtime/typescript.md +0 -139
package/docs/runtime/web-apis.md +0 -128
package/docs/test/configuration.md +0 -154
package/docs/test/coverage.md +0 -142
package/docs/test/discovery.md +0 -85
package/docs/test/dom.md +0 -75
package/docs/test/examples/concurrent-test-glob.md +0 -132
package/docs/test/hot.md +0 -15
package/docs/test/lifecycle.md +0 -81
package/docs/test/mocks.md +0 -313
package/docs/test/reporters.md +0 -117
package/docs/test/runtime-behavior.md +0 -95
package/docs/test/snapshots.md +0 -68
package/docs/test/time.md +0 -126
package/docs/test/writing.md +0 -825
package/docs/typescript.md +0 -53

package/docs/bundler/fullstack.md DELETED Viewed

@@ -1,418 +0,0 @@
-To get started, import HTML files and pass them to the `routes` option in `Bun.serve()`.
-```ts
-import { sql, serve } from "bun";
-import dashboard from "./dashboard.html";
-import homepage from "./index.html";
-const server = serve({
-  routes: {
-    // ** HTML imports **
-    // Bundle & route index.html to "/". This uses HTMLRewriter to scan the HTML for `<script>` and `<link>` tags, run's Bun's JavaScript & CSS bundler on them, transpiles any TypeScript, JSX, and TSX, downlevels CSS with Bun's CSS parser and serves the result.
-    "/": homepage,
-    // Bundle & route dashboard.html to "/dashboard"
-    "/dashboard": dashboard,
-    // ** API endpoints ** (Bun v1.2.3+ required)
-    "/api/users": {
-      async GET(req) {
-        const users = await sql`SELECT * FROM users`;
-        return Response.json(users);
-      },
-      async POST(req) {
-        const { name, email } = await req.json();
-        const [user] =
-          await sql`INSERT INTO users (name, email) VALUES (${name}, ${email})`;
-        return Response.json(user);
-      },
-    },
-    "/api/users/:id": async req => {
-      const { id } = req.params;
-      const [user] = await sql`SELECT * FROM users WHERE id = ${id}`;
-      return Response.json(user);
-    },
-  },
-  // Enable development mode for:
-  // - Detailed error messages
-  // - Hot reloading (Bun v1.2.3+ required)
-  development: true,
-  // Prior to v1.2.3, the `fetch` option was used to handle all API requests. It is now optional.
-  // async fetch(req) {
-  //   // Return 404 for unmatched routes
-  //   return new Response("Not Found", { status: 404 });
-  // },
-});
-console.log(`Listening on ${server.url}`);
-```
-```bash
-$ bun run app.ts
-```
-## HTML imports are routes
-The web starts with HTML, and so does Bun's fullstack dev server.
-To specify entrypoints to your frontend, import HTML files into your JavaScript/TypeScript/TSX/JSX files.
-```ts
-import dashboard from "./dashboard.html";
-import homepage from "./index.html";
-```
-These HTML files are used as routes in Bun's dev server you can pass to `Bun.serve()`.
-```ts
-Bun.serve({
-  routes: {
-    "/": homepage,
-    "/dashboard": dashboard,
-  }
-  fetch(req) {
-    // ... api requests
-  },
-});
-```
-When you make a request to `/dashboard` or `/`, Bun automatically bundles the `<script>` and `<link>` tags in the HTML files, exposes them as static routes, and serves the result.
-An index.html file like this:
-```html#index.html
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Home</title>
-    <link rel="stylesheet" href="./reset.css" />
-    <link rel="stylesheet" href="./styles.css" />
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="./sentry-and-preloads.ts"></script>
-    <script type="module" src="./my-app.tsx"></script>
-  </body>
-</html>
-```
-Becomes something like this:
-```html#index.html
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Home</title>
-    <link rel="stylesheet" href="/index-[hash].css" />
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/index-[hash].js"></script>
-  </body>
-</html>
-```
-### How to use with React
-To use React in your client-side code, import `react-dom/client` and render your app.
-{% codetabs %}
-```ts#src/backend.ts
-import dashboard from "../public/dashboard.html";
-import { serve } from "bun";
-serve({
-  routes: {
-    "/": dashboard,
-  },
-  async fetch(req) {
-    // ...api requests
-    return new Response("hello world");
-  },
-});
-```
-```ts#src/frontend.tsx
-import "./styles.css";
-import { createRoot } from "react-dom/client";
-import { App } from "./app.tsx";
-document.addEventListener("DOMContentLoaded", () => {
-  const root = createRoot(document.getElementById("root"));
-  root.render(<App />);
-});
-```
-```html#public/dashboard.html
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Dashboard</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="../src/frontend.tsx"></script>
-  </body>
-</html>
-```
-```css#src/styles.css
-body {
-  background-color: red;
-}
-```
-```tsx#src/app.tsx
-export function App() {
-  return <div>Hello World</div>;
-}
-```
-{% /codetabs %}
-### Development mode
-When building locally, enable development mode by setting `development: true` in `Bun.serve()`.
-```js-diff
-import homepage from "./index.html";
-import dashboard from "./dashboard.html";
-Bun.serve({
-  routes: {
-    "/": homepage,
-    "/dashboard": dashboard,
-  }
-+ development: true,
-  fetch(req) {
-    // ... api requests
-  },
-});
-```
-When `development` is `true`, Bun will:
-- Include the `SourceMap` header in the response so that devtools can show the original source code
-- Disable minification
-- Re-bundle assets on each request to a .html file
-- Enable hot module reloading (unless `hmr: false` is set)
-#### Echo console logs from browser to terminal
-Bun.serve() supports echoing console logs from the browser to the terminal.
-To enable this, pass `console: true` in the `development` object in `Bun.serve()`.
-```ts
-import homepage from "./index.html";
-Bun.serve({
-  // development can also be an object.
-  development: {
-    // Enable Hot Module Reloading
-    hmr: true,
-    // Echo console logs from the browser to the terminal
-    console: true,
-  },
-  routes: {
-    "/": homepage,
-  },
-});
-```
-When `console: true` is set, Bun will stream console logs from the browser to the terminal. This reuses the existing WebSocket connection from HMR to send the logs.
-#### Production mode
-Hot reloading and `development: true` helps you iterate quickly, but in production, your server should be as fast as possible and have as few external dependencies as possible.
-##### Ahead of time bundling (recommended)
-As of Bun v1.2.17, you can use `Bun.build` or `bun build` to bundle your full-stack application ahead of time.
-```sh
-$ bun build --target=bun --production --outdir=dist ./src/index.ts
-```
-When Bun's bundler sees an HTML import from server-side code, it will bundle the referenced JavaScript/TypeScript/TSX/JSX and CSS files into a manifest object that Bun.serve() can use to serve the assets.
-```ts
-import { serve } from "bun";
-import index from "./index.html";
-serve({
-  routes: { "/": index },
-});
-```
-{% details summary="Internally, the `index` variable is a manifest object that looks something like this" %}
-```json
-{
-  "index": "./index.html",
-  "files": [
-    {
-      "input": "index.html",
-      "path": "./index-f2me3qnf.js",
-      "loader": "js",
-      "isEntry": true,
-      "headers": {
-        "etag": "eet6gn75",
-        "content-type": "text/javascript;charset=utf-8"
-      }
-    },
-    {
-      "input": "index.html",
-      "path": "./index.html",
-      "loader": "html",
-      "isEntry": true,
-      "headers": {
-        "etag": "r9njjakd",
-        "content-type": "text/html;charset=utf-8"
-      }
-    },
-    {
-      "input": "index.html",
-      "path": "./index-gysa5fmk.css",
-      "loader": "css",
-      "isEntry": true,
-      "headers": {
-        "etag": "50zb7x61",
-        "content-type": "text/css;charset=utf-8"
-      }
-    },
-    {
-      "input": "logo.svg",
-      "path": "./logo-kygw735p.svg",
-      "loader": "file",
-      "isEntry": false,
-      "headers": {
-        "etag": "kygw735p",
-        "content-type": "application/octet-stream"
-      }
-    },
-    {
-      "input": "react.svg",
-      "path": "./react-ck11dneg.svg",
-      "loader": "file",
-      "isEntry": false,
-      "headers": {
-        "etag": "ck11dneg",
-        "content-type": "application/octet-stream"
-      }
-    }
-  ]
-}
-```
-{% /details %}
-##### Runtime bundling
-When adding a build step is too complicated, you can set `development: false` in `Bun.serve()`.
-- Enable in-memory caching of bundled assets. Bun will bundle assets lazily on the first request to an `.html` file, and cache the result in memory until the server restarts.
-- Enables `Cache-Control` headers and `ETag` headers
-- Minifies JavaScript/TypeScript/TSX/JSX files
-## Plugins
-Bun's [bundler plugins](https://bun.com/docs/bundler/plugins) are also supported when bundling static routes.
-To configure plugins for `Bun.serve`, add a `plugins` array in the `[serve.static]` section of your `bunfig.toml`.
-### Using TailwindCSS in HTML routes
-For example, enable TailwindCSS on your routes by installing and adding the `bun-plugin-tailwind` plugin:
-```sh
-$ bun add bun-plugin-tailwind
-```
-```toml#bunfig.toml
-[serve.static]
-plugins = ["bun-plugin-tailwind"]
-```
-This will allow you to use TailwindCSS utility classes in your HTML and CSS files. All you need to do is import `tailwindcss` somewhere:
-```html#index.html
-<!doctype html>
-<html>
-  <head>
-    <title>Home</title>
-    <link rel="stylesheet" href="tailwindcss" />
-  </head>
-  <body>
-    <!-- the rest of your HTML... -->
-  </body>
-</html>
-```
-Or in your CSS:
-```css#style.css
-@import "tailwindcss";
-```
-### Custom plugins
-Any JS file or module which exports a [valid bundler plugin object](https://bun.com/docs/bundler/plugins#usage) (essentially an object with a `name` and `setup` field) can be placed inside the `plugins` array:
-```toml#bunfig.toml
-[serve.static]
-plugins = ["./my-plugin-implementation.ts"]
-```
-Bun will lazily resolve and load each plugin and use them to bundle your routes.
-Note: this is currently in `bunfig.toml` to make it possible to know statically which plugins are in use when we eventually integrate this with the `bun build` CLI. These plugins work in `Bun.build()`'s JS API, but are not yet supported in the CLI.
-## How this works
-Bun uses [`HTMLRewriter`](/docs/api/html-rewriter) to scan for `<script>` and `<link>` tags in HTML files, uses them as entrypoints for [Bun's bundler](/docs/bundler), generates an optimized bundle for the JavaScript/TypeScript/TSX/JSX and CSS files, and serves the result.
-1. **`<script>` processing**
-   - Transpiles TypeScript, JSX, and TSX in `<script>` tags
-   - Bundles imported dependencies
-   - Generates sourcemaps for debugging
-   - Minifies when `development` is not `true` in `Bun.serve()`
-   ```html
-   <script type="module" src="./counter.tsx"></script>
-   ```
-2. **`<link>` processing**
-   - Processes CSS imports and `<link>` tags
-   - Concatenates CSS files
-   - Rewrites `url` and asset paths to include content-addressable hashes in URLs
-   ```html
-   <link rel="stylesheet" href="./styles.css" />
-   ```
-3. **`<img>` & asset processing**
-   - Links to assets are rewritten to include content-addressable hashes in URLs
-   - Small assets in CSS files are inlined into `data:` URLs, reducing the total number of HTTP requests sent over the wire
-4. **Rewrite HTML**
-   - Combines all `<script>` tags into a single `<script>` tag with a content-addressable hash in the URL
-   - Combines all `<link>` tags into a single `<link>` tag with a content-addressable hash in the URL
-   - Outputs a new HTML file
-5. **Serve**
-   - All the output files from the bundler are exposed as static routes, using the same mechanism internally as when you pass a `Response` object to [`static` in `Bun.serve()`](/docs/api/http#static-routes).
-This works similarly to how [`Bun.build` processes HTML files](/docs/bundler/html).
-## This is a work in progress
-- This doesn't support `bun build` yet. It also will in the future.

package/docs/bundler/hmr.md DELETED Viewed

@@ -1,234 +0,0 @@
-Hot Module Replacement (HMR) allows you to update modules in a running
-application without needing a full page reload. This preserves the application
-state and improves the development experience.
-HMR is enabled by default when using Bun's full-stack development server.
-## `import.meta.hot` API Reference
-Bun implements a client-side HMR API modeled after [Vite's `import.meta.hot` API](https://vitejs.dev/guide/api-hmr.html). It can be checked for with `if (import.meta.hot)`, tree-shaking it in production
-```ts
-if (import.meta.hot) {
-  // HMR APIs are available.
-}
-```
-However, **this check is often not needed** as Bun will dead-code-eliminate
-calls to all of the HMR APIs in production builds.
-```ts
-// This entire function call will be removed in production!
-import.meta.hot.dispose(() => {
-  console.log("dispose");
-});
-```
-For this to work, Bun forces these APIs to be called without indirection. That means the following do not work:
-```ts#invalid-hmr-usage.ts
-// INVALID: Assigning `hot` to a variable
-const hot = import.meta.hot;
-hot.accept();
-// INVALID: Assigning `import.meta` to a variable
-const meta = import.meta;
-meta.hot.accept();
-console.log(meta.hot.data);
-// INVALID: Passing to a function
-doSomething(import.meta.hot.dispose);
-// OK: The full phrase "import.meta.hot.<API>" must be called directly:
-import.meta.hot.accept();
-// OK: `data` can be passed to functions:
-doSomething(import.meta.hot.data);
-```
-{% callout %}
-**Note** — The HMR API is still a work in progress. Some features are missing. HMR can be disabled in `Bun.serve` by setting the `development` option to `{ hmr: false }`.
-{% endcallout %}
-|     | Method             | Notes                                                                 |
-| --- | ------------------ | --------------------------------------------------------------------- |
-| ✅  | `hot.accept()`     | Indicate that a hot update can be replaced gracefully.                |
-| ✅  | `hot.data`         | Persist data between module evaluations.                              |
-| ✅  | `hot.dispose()`    | Add a callback function to run when a module is about to be replaced. |
-| ❌  | `hot.invalidate()` |                                                                       |
-| ✅  | `hot.on()`         | Attach an event listener                                              |
-| ✅  | `hot.off()`        | Remove an event listener from `on`.                                   |
-| ❌  | `hot.send()`       |                                                                       |
-| 🚧  | `hot.prune()`      | **NOTE**: Callback is currently never called.                         |
-| ✅  | `hot.decline()`    | No-op to match Vite's `import.meta.hot`                               |
-### `import.meta.hot.accept()`
-The `accept()` method indicates that a module can be hot-replaced. When called
-without arguments, it indicates that this module can be replaced simply by
-re-evaluating the file. After a hot update, importers of this module will be
-automatically patched.
-```ts#index.ts
-import { getCount } from "./foo.ts";
-console.log("count is ", getCount());
-import.meta.hot.accept();
-export function getNegativeCount() {
-  return -getCount();
-}
-```
-This creates a hot-reloading boundary for all of the files that `index.ts`
-imports. That means whenever `foo.ts` or any of its dependencies are saved, the
-update will bubble up to `index.ts` will re-evaluate. Files that import
-`index.ts` will then be patched to import the new version of
-`getNegativeCount()`. If only `index.ts` is updated, only the one file will be
-re-evaluated, and the counter in `foo.ts` is reused.
-This may be used in combination with `import.meta.hot.data` to transfer state
-from the previous module to the new one.
-When no modules call `import.meta.hot.accept()` (and there isn't React Fast
-Refresh or a plugin calling it for you), the page will reload when the file
-updates, and a console warning shows which files were invalidated. This warning
-is safe to ignore if it makes more sense to rely on full page reloads.
-#### With callback
-When provided one callback, `import.meta.hot.accept` will function how it does
-in Vite. Instead of patching the importers of this module, it will call the
-callback with the new module.
-```ts
-export const count = 0;
-import.meta.hot.accept(newModule => {
-  if (newModule) {
-    // newModule is undefined when SyntaxError happened
-    console.log("updated: count is now ", newModule.count);
-  }
-});
-```
-Prefer using `import.meta.hot.accept()` without an argument as it usually makes your code easier to understand.
-#### Accepting other modules
-```ts
-import { count } from "./foo";
-import.meta.hot.accept("./foo", () => {
-  if (!newModule) return;
-  console.log("updated: count is now ", count);
-});
-```
-Indicates that a dependency's module can be accepted. When the dependency is updated, the callback will be called with the new module.
-#### With multiple dependencies
-```ts
-import.meta.hot.accept(["./foo", "./bar"], newModules => {
-  // newModules is an array where each item corresponds to the updated module
-  // or undefined if that module had a syntax error
-});
-```
-Indicates that multiple dependencies' modules can be accepted. This variant accepts an array of dependencies, where the callback will receive the updated modules, and `undefined` for any that had errors.
-### `import.meta.hot.data`
-`import.meta.hot.data` maintains state between module instances during hot
-replacement, enabling data transfer from previous to new versions. When
-`import.meta.hot.data` is written into, Bun will also mark this module as
-capable of self-accepting (equivalent of calling `import.meta.hot.accept()`).
-```ts
-import { createRoot } from "react-dom/client";
-import { App } from "./app";
-const root = import.meta.hot.data.root ??= createRoot(elem);
-root.render(<App />); // re-use an existing root
-```
-In production, `data` is inlined to be `{}`, meaning it cannot be used as a state holder.
-The above pattern is recommended for stateful modules because Bun knows it can minify `{}.prop ??= value` into `value` in production.
-### `import.meta.hot.dispose()`
-Attaches an on-dispose callback. This is called:
-- Just before the module is replaced with another copy (before the next is loaded)
-- After the module is detached (removing all imports to this module, see `import.meta.hot.prune()`)
-```ts
-const sideEffect = setupSideEffect();
-import.meta.hot.dispose(() => {
-  sideEffect.cleanup();
-});
-```
-This callback is not called on route navigation or when the browser tab closes.
-Returning a promise will delay module replacement until the module is disposed.
-All dispose callbacks are called in parallel.
-### `import.meta.hot.prune()`
-Attaches an on-prune callback. This is called when all imports to this module
-are removed, but the module was previously loaded.
-This can be used to clean up resources that were created when the module was
-loaded. Unlike `import.meta.hot.dispose()`, this pairs much better with `accept`
-and `data` to manage stateful resources. A full example managing a `WebSocket`:
-```ts
-import { something } from "./something";
-// Initialize or re-use a WebSocket connection
-export const ws = (import.meta.hot.data.ws ??= new WebSocket(location.origin));
-// If the module's import is removed, clean up the WebSocket connection.
-import.meta.hot.prune(() => {
-  ws.close();
-});
-```
-If `dispose` was used instead, the WebSocket would close and re-open on every
-hot update. Both versions of the code will prevent page reloads when imported
-files are updated.
-### `import.meta.hot.on()` and `off()`
-`on()` and `off()` are used to listen for events from the HMR runtime. Event names are prefixed with a prefix so that plugins do not conflict with each other.
-```ts
-import.meta.hot.on("bun:beforeUpdate", () => {
-  console.log("before a hot update");
-});
-```
-When a file is replaced, all of its event listeners are automatically removed.
-A list of all built-in events:
-| Event                  | Emitted when                                                                                    |
-| ---------------------- | ----------------------------------------------------------------------------------------------- |
-| `bun:beforeUpdate`     | before a hot update is applied.                                                                 |
-| `bun:afterUpdate`      | after a hot update is applied.                                                                  |
-| `bun:beforeFullReload` | before a full page reload happens.                                                              |
-| `bun:beforePrune`      | before prune callbacks are called.                                                              |
-| `bun:invalidate`       | when a module is invalidated with `import.meta.hot.invalidate()`                                |
-| `bun:error`            | when a build or runtime error occurs                                                            |
-| `bun:ws:disconnect`    | when the HMR WebSocket connection is lost. This can indicate the development server is offline. |
-| `bun:ws:connect`       | when the HMR WebSocket connects or re-connects.                                                 |
-For compatibility with Vite, the above events are also available via `vite:*` prefix instead of `bun:*`.