bun-types 1.3.2-canary.20251104T140728 → 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 (312) hide show
  1. package/bun.d.ts +4 -4
  2. package/docs/README.md +28 -0
  3. package/globals.d.ts +0 -1
  4. package/overrides.d.ts +45 -15
  5. package/package.json +1 -1
  6. package/test.d.ts +1 -1
  7. package/docs/api/binary-data.md +0 -1038
  8. package/docs/api/cc.md +0 -197
  9. package/docs/api/color.md +0 -262
  10. package/docs/api/console.md +0 -57
  11. package/docs/api/cookie.md +0 -449
  12. package/docs/api/dns.md +0 -110
  13. package/docs/api/fetch.md +0 -463
  14. package/docs/api/ffi.md +0 -557
  15. package/docs/api/file-io.md +0 -366
  16. package/docs/api/file-system-router.md +0 -112
  17. package/docs/api/file.md +0 -19
  18. package/docs/api/glob.md +0 -178
  19. package/docs/api/globals.md +0 -387
  20. package/docs/api/hashing.md +0 -319
  21. package/docs/api/html-rewriter.md +0 -334
  22. package/docs/api/http.md +0 -1408
  23. package/docs/api/import-meta.md +0 -69
  24. package/docs/api/node-api.md +0 -14
  25. package/docs/api/redis.md +0 -597
  26. package/docs/api/s3.md +0 -850
  27. package/docs/api/secrets.md +0 -319
  28. package/docs/api/semver.md +0 -52
  29. package/docs/api/spawn.md +0 -582
  30. package/docs/api/sql.md +0 -1374
  31. package/docs/api/sqlite.md +0 -694
  32. package/docs/api/streams.md +0 -230
  33. package/docs/api/tcp.md +0 -221
  34. package/docs/api/transpiler.md +0 -276
  35. package/docs/api/udp.md +0 -123
  36. package/docs/api/utils.md +0 -891
  37. package/docs/api/websockets.md +0 -573
  38. package/docs/api/workers.md +0 -322
  39. package/docs/api/yaml.md +0 -668
  40. package/docs/benchmarks.md +0 -120
  41. package/docs/bun-flavored-toml.md +0 -42
  42. package/docs/bundler/css.md +0 -1028
  43. package/docs/bundler/css_modules.md +0 -145
  44. package/docs/bundler/executables.md +0 -626
  45. package/docs/bundler/fullstack.md +0 -418
  46. package/docs/bundler/hmr.md +0 -234
  47. package/docs/bundler/html.md +0 -349
  48. package/docs/bundler/index.md +0 -1735
  49. package/docs/bundler/intro.md +0 -75
  50. package/docs/bundler/loaders.md +0 -410
  51. package/docs/bundler/macros.md +0 -329
  52. package/docs/bundler/plugins.md +0 -449
  53. package/docs/bundler/vs-esbuild.md +0 -1127
  54. package/docs/cli/add.md +0 -173
  55. package/docs/cli/bun-completions.md +0 -3
  56. package/docs/cli/bun-create.md +0 -338
  57. package/docs/cli/bun-install.md +0 -349
  58. package/docs/cli/bun-upgrade.md +0 -39
  59. package/docs/cli/bunx.md +0 -89
  60. package/docs/cli/filter.md +0 -90
  61. package/docs/cli/info.md +0 -65
  62. package/docs/cli/init.md +0 -85
  63. package/docs/cli/install.md +0 -344
  64. package/docs/cli/link.md +0 -40
  65. package/docs/cli/outdated.md +0 -90
  66. package/docs/cli/patch-commit.md +0 -11
  67. package/docs/cli/pm.md +0 -285
  68. package/docs/cli/publish.md +0 -120
  69. package/docs/cli/remove.md +0 -7
  70. package/docs/cli/run.md +0 -261
  71. package/docs/cli/test.md +0 -397
  72. package/docs/cli/unlink.md +0 -9
  73. package/docs/cli/update.md +0 -129
  74. package/docs/cli/why.md +0 -67
  75. package/docs/contributing/upgrading-webkit.md +0 -57
  76. package/docs/ecosystem/elysia.md +0 -24
  77. package/docs/ecosystem/express.md +0 -37
  78. package/docs/ecosystem/hono.md +0 -18
  79. package/docs/ecosystem/react.md +0 -65
  80. package/docs/ecosystem/stric.md +0 -38
  81. package/docs/guides/binary/arraybuffer-to-array.md +0 -27
  82. package/docs/guides/binary/arraybuffer-to-blob.md +0 -24
  83. package/docs/guides/binary/arraybuffer-to-buffer.md +0 -25
  84. package/docs/guides/binary/arraybuffer-to-string.md +0 -15
  85. package/docs/guides/binary/arraybuffer-to-typedarray.md +0 -39
  86. package/docs/guides/binary/blob-to-arraybuffer.md +0 -14
  87. package/docs/guides/binary/blob-to-dataview.md +0 -14
  88. package/docs/guides/binary/blob-to-stream.md +0 -14
  89. package/docs/guides/binary/blob-to-string.md +0 -15
  90. package/docs/guides/binary/blob-to-typedarray.md +0 -14
  91. package/docs/guides/binary/buffer-to-arraybuffer.md +0 -14
  92. package/docs/guides/binary/buffer-to-blob.md +0 -14
  93. package/docs/guides/binary/buffer-to-readablestream.md +0 -41
  94. package/docs/guides/binary/buffer-to-string.md +0 -25
  95. package/docs/guides/binary/buffer-to-typedarray.md +0 -14
  96. package/docs/guides/binary/dataview-to-string.md +0 -15
  97. package/docs/guides/binary/typedarray-to-arraybuffer.md +0 -25
  98. package/docs/guides/binary/typedarray-to-blob.md +0 -16
  99. package/docs/guides/binary/typedarray-to-buffer.md +0 -14
  100. package/docs/guides/binary/typedarray-to-dataview.md +0 -14
  101. package/docs/guides/binary/typedarray-to-readablestream.md +0 -41
  102. package/docs/guides/binary/typedarray-to-string.md +0 -16
  103. package/docs/guides/deployment/railway.md +0 -157
  104. package/docs/guides/ecosystem/astro.md +0 -72
  105. package/docs/guides/ecosystem/discordjs.md +0 -77
  106. package/docs/guides/ecosystem/docker.md +0 -140
  107. package/docs/guides/ecosystem/drizzle.md +0 -185
  108. package/docs/guides/ecosystem/edgedb.md +0 -228
  109. package/docs/guides/ecosystem/elysia.md +0 -31
  110. package/docs/guides/ecosystem/express.md +0 -40
  111. package/docs/guides/ecosystem/hono.md +0 -39
  112. package/docs/guides/ecosystem/mongoose.md +0 -87
  113. package/docs/guides/ecosystem/neon-drizzle.md +0 -220
  114. package/docs/guides/ecosystem/neon-serverless-postgres.md +0 -55
  115. package/docs/guides/ecosystem/nextjs.md +0 -49
  116. package/docs/guides/ecosystem/nuxt.md +0 -56
  117. package/docs/guides/ecosystem/pm2.md +0 -57
  118. package/docs/guides/ecosystem/prisma.md +0 -141
  119. package/docs/guides/ecosystem/qwik.md +0 -107
  120. package/docs/guides/ecosystem/react.md +0 -50
  121. package/docs/guides/ecosystem/remix.md +0 -78
  122. package/docs/guides/ecosystem/render.md +0 -79
  123. package/docs/guides/ecosystem/sentry.md +0 -52
  124. package/docs/guides/ecosystem/solidstart.md +0 -58
  125. package/docs/guides/ecosystem/ssr-react.md +0 -51
  126. package/docs/guides/ecosystem/stric.md +0 -55
  127. package/docs/guides/ecosystem/sveltekit.md +0 -125
  128. package/docs/guides/ecosystem/systemd.md +0 -113
  129. package/docs/guides/ecosystem/vite.md +0 -71
  130. package/docs/guides/html-rewriter/extract-links.md +0 -68
  131. package/docs/guides/html-rewriter/extract-social-meta.md +0 -93
  132. package/docs/guides/http/cluster.md +0 -66
  133. package/docs/guides/http/fetch-unix.md +0 -33
  134. package/docs/guides/http/fetch.md +0 -24
  135. package/docs/guides/http/file-uploads.md +0 -94
  136. package/docs/guides/http/hot.md +0 -26
  137. package/docs/guides/http/proxy.md +0 -24
  138. package/docs/guides/http/server.md +0 -46
  139. package/docs/guides/http/simple.md +0 -18
  140. package/docs/guides/http/stream-file.md +0 -48
  141. package/docs/guides/http/stream-iterator.md +0 -47
  142. package/docs/guides/http/stream-node-streams-in-bun.md +0 -20
  143. package/docs/guides/http/tls.md +0 -30
  144. package/docs/guides/install/add-dev.md +0 -26
  145. package/docs/guides/install/add-git.md +0 -36
  146. package/docs/guides/install/add-optional.md +0 -25
  147. package/docs/guides/install/add-peer.md +0 -43
  148. package/docs/guides/install/add-tarball.md +0 -33
  149. package/docs/guides/install/add.md +0 -42
  150. package/docs/guides/install/azure-artifacts.md +0 -73
  151. package/docs/guides/install/cicd.md +0 -41
  152. package/docs/guides/install/custom-registry.md +0 -30
  153. package/docs/guides/install/from-npm-install-to-bun-install.md +0 -214
  154. package/docs/guides/install/git-diff-bun-lockfile.md +0 -44
  155. package/docs/guides/install/jfrog-artifactory.md +0 -28
  156. package/docs/guides/install/npm-alias.md +0 -23
  157. package/docs/guides/install/registry-scope.md +0 -38
  158. package/docs/guides/install/trusted.md +0 -46
  159. package/docs/guides/install/workspaces.md +0 -70
  160. package/docs/guides/install/yarnlock.md +0 -44
  161. package/docs/guides/process/argv.md +0 -58
  162. package/docs/guides/process/ctrl-c.md +0 -16
  163. package/docs/guides/process/ipc.md +0 -66
  164. package/docs/guides/process/nanoseconds.md +0 -13
  165. package/docs/guides/process/os-signals.md +0 -39
  166. package/docs/guides/process/spawn-stderr.md +0 -31
  167. package/docs/guides/process/spawn-stdout.md +0 -26
  168. package/docs/guides/process/spawn.md +0 -41
  169. package/docs/guides/process/stdin.md +0 -54
  170. package/docs/guides/read-file/arraybuffer.md +0 -28
  171. package/docs/guides/read-file/buffer.md +0 -19
  172. package/docs/guides/read-file/exists.md +0 -16
  173. package/docs/guides/read-file/json.md +0 -17
  174. package/docs/guides/read-file/mime.md +0 -20
  175. package/docs/guides/read-file/stream.md +0 -26
  176. package/docs/guides/read-file/string.md +0 -22
  177. package/docs/guides/read-file/uint8array.md +0 -21
  178. package/docs/guides/read-file/watch.md +0 -68
  179. package/docs/guides/runtime/build-time-constants.md +0 -293
  180. package/docs/guides/runtime/cicd.md +0 -43
  181. package/docs/guides/runtime/codesign-macos-executable.md +0 -56
  182. package/docs/guides/runtime/define-constant.md +0 -145
  183. package/docs/guides/runtime/delete-directory.md +0 -37
  184. package/docs/guides/runtime/delete-file.md +0 -19
  185. package/docs/guides/runtime/heap-snapshot.md +0 -26
  186. package/docs/guides/runtime/import-html.md +0 -15
  187. package/docs/guides/runtime/import-json.md +0 -44
  188. package/docs/guides/runtime/import-toml.md +0 -30
  189. package/docs/guides/runtime/import-yaml.md +0 -102
  190. package/docs/guides/runtime/read-env.md +0 -32
  191. package/docs/guides/runtime/set-env.md +0 -47
  192. package/docs/guides/runtime/shell.md +0 -40
  193. package/docs/guides/runtime/timezone.md +0 -35
  194. package/docs/guides/runtime/tsconfig-paths.md +0 -29
  195. package/docs/guides/runtime/typescript.md +0 -49
  196. package/docs/guides/runtime/vscode-debugger.md +0 -47
  197. package/docs/guides/runtime/web-debugger.md +0 -82
  198. package/docs/guides/streams/node-readable-to-arraybuffer.md +0 -11
  199. package/docs/guides/streams/node-readable-to-blob.md +0 -11
  200. package/docs/guides/streams/node-readable-to-json.md +0 -12
  201. package/docs/guides/streams/node-readable-to-string.md +0 -12
  202. package/docs/guides/streams/node-readable-to-uint8array.md +0 -11
  203. package/docs/guides/streams/to-array.md +0 -14
  204. package/docs/guides/streams/to-arraybuffer.md +0 -14
  205. package/docs/guides/streams/to-blob.md +0 -14
  206. package/docs/guides/streams/to-buffer.md +0 -15
  207. package/docs/guides/streams/to-json.md +0 -14
  208. package/docs/guides/streams/to-string.md +0 -14
  209. package/docs/guides/streams/to-typedarray.md +0 -22
  210. package/docs/guides/test/bail.md +0 -22
  211. package/docs/guides/test/coverage-threshold.md +0 -60
  212. package/docs/guides/test/coverage.md +0 -44
  213. package/docs/guides/test/happy-dom.md +0 -68
  214. package/docs/guides/test/migrate-from-jest.md +0 -143
  215. package/docs/guides/test/mock-clock.md +0 -48
  216. package/docs/guides/test/mock-functions.md +0 -68
  217. package/docs/guides/test/rerun-each.md +0 -14
  218. package/docs/guides/test/run-tests.md +0 -111
  219. package/docs/guides/test/skip-tests.md +0 -39
  220. package/docs/guides/test/snapshot.md +0 -95
  221. package/docs/guides/test/spy-on.md +0 -46
  222. package/docs/guides/test/svelte-test.md +0 -120
  223. package/docs/guides/test/testing-library.md +0 -92
  224. package/docs/guides/test/timeout.md +0 -15
  225. package/docs/guides/test/todo-tests.md +0 -67
  226. package/docs/guides/test/update-snapshots.md +0 -46
  227. package/docs/guides/test/watch-mode.md +0 -19
  228. package/docs/guides/util/base64.md +0 -15
  229. package/docs/guides/util/deep-equals.md +0 -39
  230. package/docs/guides/util/deflate.md +0 -18
  231. package/docs/guides/util/detect-bun.md +0 -23
  232. package/docs/guides/util/entrypoint.md +0 -17
  233. package/docs/guides/util/escape-html.md +0 -22
  234. package/docs/guides/util/file-url-to-path.md +0 -14
  235. package/docs/guides/util/gzip.md +0 -18
  236. package/docs/guides/util/hash-a-password.md +0 -54
  237. package/docs/guides/util/import-meta-dir.md +0 -13
  238. package/docs/guides/util/import-meta-file.md +0 -13
  239. package/docs/guides/util/import-meta-path.md +0 -13
  240. package/docs/guides/util/javascript-uuid.md +0 -23
  241. package/docs/guides/util/main.md +0 -32
  242. package/docs/guides/util/path-to-file-url.md +0 -14
  243. package/docs/guides/util/sleep.md +0 -22
  244. package/docs/guides/util/version.md +0 -21
  245. package/docs/guides/util/which-path-to-executable-bin.md +0 -15
  246. package/docs/guides/websocket/compression.md +0 -31
  247. package/docs/guides/websocket/context.md +0 -77
  248. package/docs/guides/websocket/pubsub.md +0 -41
  249. package/docs/guides/websocket/simple.md +0 -33
  250. package/docs/guides/write-file/append.md +0 -52
  251. package/docs/guides/write-file/basic.md +0 -44
  252. package/docs/guides/write-file/blob.md +0 -28
  253. package/docs/guides/write-file/cat.md +0 -17
  254. package/docs/guides/write-file/file-cp.md +0 -16
  255. package/docs/guides/write-file/filesink.md +0 -52
  256. package/docs/guides/write-file/response.md +0 -17
  257. package/docs/guides/write-file/stdout.md +0 -21
  258. package/docs/guides/write-file/stream.md +0 -17
  259. package/docs/guides/write-file/unlink.md +0 -16
  260. package/docs/index.md +0 -77
  261. package/docs/install/audit.md +0 -57
  262. package/docs/install/cache.md +0 -59
  263. package/docs/install/catalogs.md +0 -298
  264. package/docs/install/index.md +0 -248
  265. package/docs/install/isolated.md +0 -197
  266. package/docs/install/lifecycle.md +0 -46
  267. package/docs/install/lockfile.md +0 -58
  268. package/docs/install/npmrc.md +0 -105
  269. package/docs/install/overrides.md +0 -73
  270. package/docs/install/patch.md +0 -59
  271. package/docs/install/registries.md +0 -30
  272. package/docs/install/security-scanner-api.md +0 -81
  273. package/docs/install/workspaces.md +0 -114
  274. package/docs/installation.md +0 -327
  275. package/docs/project/asan.md +0 -124
  276. package/docs/project/benchmarking.md +0 -203
  277. package/docs/project/bindgen.md +0 -225
  278. package/docs/project/building-windows.md +0 -162
  279. package/docs/project/contributing.md +0 -347
  280. package/docs/project/internals/build-process-for-ci.md +0 -75
  281. package/docs/project/licensing.md +0 -73
  282. package/docs/project/roadmap.md +0 -87
  283. package/docs/quickstart.md +0 -157
  284. package/docs/runtime/autoimport.md +0 -94
  285. package/docs/runtime/bun-apis.md +0 -207
  286. package/docs/runtime/bunfig.md +0 -772
  287. package/docs/runtime/debugger.md +0 -325
  288. package/docs/runtime/env.md +0 -253
  289. package/docs/runtime/hot.md +0 -145
  290. package/docs/runtime/index.md +0 -312
  291. package/docs/runtime/jsx.md +0 -385
  292. package/docs/runtime/loaders.md +0 -130
  293. package/docs/runtime/modules.md +0 -320
  294. package/docs/runtime/nodejs-apis.md +0 -463
  295. package/docs/runtime/plugins.md +0 -561
  296. package/docs/runtime/shell.md +0 -605
  297. package/docs/runtime/typescript.md +0 -139
  298. package/docs/runtime/web-apis.md +0 -128
  299. package/docs/test/configuration.md +0 -154
  300. package/docs/test/coverage.md +0 -142
  301. package/docs/test/discovery.md +0 -85
  302. package/docs/test/dom.md +0 -75
  303. package/docs/test/examples/concurrent-test-glob.md +0 -132
  304. package/docs/test/hot.md +0 -15
  305. package/docs/test/lifecycle.md +0 -81
  306. package/docs/test/mocks.md +0 -313
  307. package/docs/test/reporters.md +0 -117
  308. package/docs/test/runtime-behavior.md +0 -95
  309. package/docs/test/snapshots.md +0 -68
  310. package/docs/test/time.md +0 -126
  311. package/docs/test/writing.md +0 -825
  312. package/docs/typescript.md +0 -53
@@ -1,349 +0,0 @@
1
- Bun's bundler has first-class support for HTML. Build static sites, landing pages, and web applications with zero configuration. Just point Bun at your HTML file and it handles everything else.
2
-
3
- ```html#index.html
4
- <!doctype html>
5
- <html>
6
- <head>
7
- <link rel="stylesheet" href="./styles.css" />
8
- <script src="./app.ts" type="module"></script>
9
- </head>
10
- <body>
11
- <img src="./logo.png" />
12
- </body>
13
- </html>
14
- ```
15
-
16
- To get started, pass HTML files to `bun`.
17
-
18
- {% bunDevServerTerminal alt="bun ./index.html" path="./index.html" routes="" /%}
19
-
20
- Bun's development server provides powerful features with zero configuration:
21
-
22
- - **Automatic Bundling** - Bundles and serves your HTML, JavaScript, and CSS
23
- - **Multi-Entry Support** - Handles multiple HTML entry points and glob entry points
24
- - **Modern JavaScript** - TypeScript & JSX support out of the box
25
- - **Smart Configuration** - Reads `tsconfig.json` for paths, JSX options, experimental decorators, and more
26
- - **Plugins** - Plugins for TailwindCSS and more
27
- - **ESM & CommonJS** - Use ESM and CommonJS in your JavaScript, TypeScript, and JSX files
28
- - **CSS Bundling & Minification** - Bundles CSS from `<link>` tags and `@import` statements
29
- - **Asset Management**
30
- - Automatic copying & hashing of images and assets
31
- - Rewrites asset paths in JavaScript, CSS, and HTML
32
-
33
- ## Single Page Apps (SPA)
34
-
35
- When you pass a single .html file to Bun, Bun will use it as a fallback route for all paths. This makes it perfect for single page apps that use client-side routing:
36
-
37
- {% bunDevServerTerminal alt="bun index.html" path="index.html" routes="" /%}
38
-
39
- Your React or other SPA will work out of the box — no configuration needed. All routes like `/about`, `/users/123`, etc. will serve the same HTML file, letting your client-side router handle the navigation.
40
-
41
- ```html#index.html
42
- <!doctype html>
43
- <html>
44
- <head>
45
- <title>My SPA</title>
46
- <script src="./app.tsx" type="module"></script>
47
- </head>
48
- <body>
49
- <div id="root"></div>
50
- </body>
51
- </html>
52
- ```
53
-
54
- ## Multi-page apps (MPA)
55
-
56
- Some projects have several separate routes or HTML files as entry points. To support multiple entry points, pass them all to `bun`
57
-
58
- {% bunDevServerTerminal alt="bun ./index.html ./about.html" path="./index.html ./about.html" routes="[{\"path\": \"/\", \"file\": \"./index.html\"}, {\"path\": \"/about\", \"file\": \"./about.html\"}]" /%}
59
-
60
- This will serve:
61
-
62
- - `index.html` at `/`
63
- - `about.html` at `/about`
64
-
65
- ### Glob patterns
66
-
67
- To specify multiple files, you can use glob patterns that end in `.html`:
68
-
69
- {% bunDevServerTerminal alt="bun ./**/*.html" path="./**/*.html" routes="[{\"path\": \"/\", \"file\": \"./index.html\"}, {\"path\": \"/about\", \"file\": \"./about.html\"}]" /%}
70
-
71
- ### Path normalization
72
-
73
- The base path is chosen from the longest common prefix among all the files.
74
-
75
- {% bunDevServerTerminal alt="bun ./index.html ./about/index.html ./about/foo/index.html" path="./index.html ./about/index.html ./about/foo/index.html" routes="[{\"path\": \"/\", \"file\": \"./index.html\"}, {\"path\": \"/about\", \"file\": \"./about/index.html\"}, {\"path\": \"/about/foo\", \"file\": \"./about/foo/index.html\"}]" /%}
76
-
77
- ## JavaScript, TypeScript, and JSX
78
-
79
- Bun's transpiler natively implements JavaScript, TypeScript, and JSX support. [Learn more about loaders in Bun](/docs/bundler/loaders).
80
-
81
- Bun's transpiler is also used at runtime.
82
-
83
- ### ES Modules & CommonJS
84
-
85
- You can use ESM and CJS in your JavaScript, TypeScript, and JSX files. Bun will handle the transpilation and bundling automatically.
86
-
87
- There is no pre-build or separate optimization step. It's all done at the same time.
88
-
89
- Learn more about [module resolution in Bun](/docs/runtime/modules).
90
-
91
- ## CSS
92
-
93
- Bun's CSS parser is also natively implemented (clocking in around 58,000 lines of Zig).
94
-
95
- It's also a CSS bundler. You can use `@import` in your CSS files to import other CSS files.
96
-
97
- For example:
98
-
99
- ```css#styles.css
100
- @import "./abc.css";
101
-
102
- .container {
103
- background-color: blue;
104
- }
105
- ```
106
-
107
- ```css#abc.css
108
- body {
109
- background-color: red;
110
- }
111
- ```
112
-
113
- This outputs:
114
-
115
- ```css#styles.css
116
- body {
117
- background-color: red;
118
- }
119
-
120
- .container {
121
- background-color: blue;
122
- }
123
- ```
124
-
125
- ### Referencing local assets in CSS
126
-
127
- You can reference local assets in your CSS files.
128
-
129
- ```css#styles.css
130
- body {
131
- background-image: url("./logo.png");
132
- }
133
- ```
134
-
135
- This will copy `./logo.png` to the output directory and rewrite the path in the CSS file to include a content hash.
136
-
137
- ```css#styles.css
138
- body {
139
- background-image: url("./logo-[ABC123].png");
140
- }
141
- ```
142
-
143
- ### Importing CSS in JavaScript
144
-
145
- To associate a CSS file with a JavaScript file, you can import it in your JavaScript file.
146
-
147
- ```ts#app.ts
148
- import "./styles.css";
149
- import "./more-styles.css";
150
- ```
151
-
152
- This generates `./app.css` and `./app.js` in the output directory. All CSS files imported from JavaScript will be bundled into a single CSS file per entry point. If you import the same CSS file from multiple JavaScript files, it will only be included once in the output CSS file.
153
-
154
- ## Plugins
155
-
156
- The dev server supports plugins.
157
-
158
- ### Tailwind CSS
159
-
160
- To use TailwindCSS, install the `bun-plugin-tailwind` plugin:
161
-
162
- ```bash
163
- # Or any npm client
164
- $ bun install --dev bun-plugin-tailwind
165
- ```
166
-
167
- Then, add the plugin to your `bunfig.toml`:
168
-
169
- ```toml
170
- [serve.static]
171
- plugins = ["bun-plugin-tailwind"]
172
- ```
173
-
174
- Then, reference TailwindCSS in your HTML via `<link>` tag, `@import` in CSS, or `import` in JavaScript.
175
-
176
- {% codetabs %}
177
-
178
- ```html#index.html
179
- <!-- Reference TailwindCSS in your HTML -->
180
- <link rel="stylesheet" href="tailwindcss" />
181
- ```
182
-
183
- ```css#styles.css
184
- /* Import TailwindCSS in your CSS */
185
- @import "tailwindcss";
186
- ```
187
-
188
- ```ts#app.ts
189
- /* Import TailwindCSS in your JavaScript */
190
- import "tailwindcss";
191
- ```
192
-
193
- {% /codetabs %}
194
-
195
- Only one of those are necessary, not all three.
196
-
197
- ### Echo console logs from browser to terminal
198
-
199
- Bun's dev server supports streaming console logs from the browser to the terminal.
200
-
201
- To enable, pass the `--console` CLI flag.
202
-
203
- {% bunDevServerTerminal alt="bun ./index.html --console" path="./index.html --console" routes="" /%}
204
-
205
- Each call to `console.log` or `console.error` will be broadcast to the terminal that started the server. This is useful to see errors from the browser in the same place you run your server. This is also useful for AI agents that watch terminal output.
206
-
207
- Internally, this reuses the existing WebSocket connection from hot module reloading to send the logs.
208
-
209
- ### Edit files in the browser
210
-
211
- Bun's frontend dev server has support for [Automatic Workspace Folders](https://chromium.googlesource.com/devtools/devtools-frontend/+/main/docs/ecosystem/automatic_workspace_folders.md) in Chrome DevTools, which lets you save edits to files in the browser.
212
-
213
- {% image src="/images/bun-chromedevtools.gif" alt="Bun's frontend dev server has support for Automatic Workspace Folders in Chrome DevTools, which lets you save edits to files in the browser." /%}
214
-
215
- {% details summary="How it works" %}
216
-
217
- Bun's dev server automatically adds a `/.well-known/appspecific/com.chrome.devtools.json` route to the server.
218
-
219
- This route returns a JSON object with the following shape:
220
-
221
- ```json
222
- {
223
- "workspace": {
224
- "root": "/path/to/your/project",
225
- "uuid": "a-unique-identifier-for-this-workspace"
226
- }
227
- }
228
- ```
229
-
230
- For security reasons, this is only enabled when:
231
-
232
- 1. The request is coming from localhost, 127.0.0.1, or ::1.
233
- 2. Hot Module Reloading is enabled.
234
- 3. The `chromeDevToolsAutomaticWorkspaceFolders` flag is set to `true` or `undefined`.
235
- 4. There are no other routes that match the request.
236
-
237
- You can disable this by passing `development: { chromeDevToolsAutomaticWorkspaceFolders: false }` in `Bun.serve`'s options.
238
-
239
- {% /details %}
240
-
241
- ## Keyboard Shortcuts
242
-
243
- While the server is running:
244
-
245
- - `o + Enter` - Open in browser
246
- - `c + Enter` - Clear console
247
- - `q + Enter` (or Ctrl+C) - Quit server
248
-
249
- ## Build for Production
250
-
251
- When you're ready to deploy, use `bun build` to create optimized production bundles:
252
-
253
- {% codetabs %}
254
-
255
- ```bash#CLI
256
- $ bun build ./index.html --minify --outdir=dist
257
- ```
258
-
259
- ```ts#API
260
- Bun.build({
261
- entrypoints: ["./index.html"],
262
- outdir: "./dist",
263
- minify: {
264
- whitespace: true,
265
- identifiers: true,
266
- syntax: true,
267
- }
268
- });
269
- ```
270
-
271
- {% /codetabs %}
272
-
273
- Currently, plugins are only supported through `Bun.build`'s API or through `bunfig.toml` with the frontend dev server - not yet supported in `bun build`'s CLI.
274
-
275
- ### Watch Mode
276
-
277
- You can run `bun build --watch` to watch for changes and rebuild automatically. This works nicely for library development.
278
-
279
- You've never seen a watch mode this fast.
280
-
281
- ### Plugin API
282
-
283
- Need more control? Configure the bundler through the JavaScript API and use Bun's builtin `HTMLRewriter` to preprocess HTML.
284
-
285
- ```ts
286
- await Bun.build({
287
- entrypoints: ["./index.html"],
288
- outdir: "./dist",
289
- minify: true,
290
-
291
- plugins: [
292
- {
293
- // A plugin that makes every HTML tag lowercase
294
- name: "lowercase-html-plugin",
295
- setup({ onLoad }) {
296
- const rewriter = new HTMLRewriter().on("*", {
297
- element(element) {
298
- element.tagName = element.tagName.toLowerCase();
299
- },
300
- text(element) {
301
- element.replace(element.text.toLowerCase());
302
- },
303
- });
304
-
305
- onLoad({ filter: /\.html$/ }, async args => {
306
- const html = await Bun.file(args.path).text();
307
-
308
- return {
309
- // Bun's bundler will scan the HTML for <script> tags, <link rel="stylesheet"> tags, and other assets
310
- // and bundle them automatically
311
- contents: rewriter.transform(html),
312
- loader: "html",
313
- };
314
- });
315
- },
316
- },
317
- ],
318
- });
319
- ```
320
-
321
- ## What Gets Processed?
322
-
323
- Bun automatically handles all common web assets:
324
-
325
- - Scripts (`<script src>`) are run through Bun's JavaScript/TypeScript/JSX bundler
326
- - Stylesheets (`<link rel="stylesheet">`) are run through Bun's CSS parser & bundler
327
- - Images (`<img>`, `<picture>`) are copied and hashed
328
- - Media (`<video>`, `<audio>`, `<source>`) are copied and hashed
329
- - Any `<link>` tag with an `href` attribute pointing to a local file is rewritten to the new path, and hashed
330
-
331
- All paths are resolved relative to your HTML file, making it easy to organize your project however you want.
332
-
333
- ## This is a work in progress
334
-
335
- - Need more plugins
336
- - Need more configuration options for things like asset handling
337
- - Need a way to configure CORS, headers, etc.
338
-
339
- If you want to submit a PR, most of the [code is here](https://github.com/oven-sh/bun/blob/main/src/js/internal/html.ts). You could even copy paste that file into your project and use it as a starting point.
340
-
341
- ## How this works
342
-
343
- This is a small wrapper around Bun's support for HTML imports in JavaScript.
344
-
345
- ### Adding a backend to your frontend
346
-
347
- To add a backend to your frontend, you can use the `"routes"` option in `Bun.serve`.
348
-
349
- Learn more in [the full-stack docs](/docs/bundler/fullstack).