npm - @depup/bun-types - Versions diffs - 1.3.11-depup.0 - Mend

@depup/bun-types 1.3.11-depup.0

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 (361) hide show

package/CLAUDE.md +105 -0
package/README.md +25 -0
package/bun.d.ts +8712 -0
package/bun.ns.d.ts +5 -0
package/bundle.d.ts +74 -0
package/changes.json +5 -0
package/deprecated.d.ts +184 -0
package/devserver.d.ts +187 -0
package/docs/README.md +28 -0
package/docs/bundler/bytecode.mdx +447 -0
package/docs/bundler/css.mdx +1024 -0
package/docs/bundler/esbuild.mdx +304 -0
package/docs/bundler/executables.mdx +1318 -0
package/docs/bundler/fullstack.mdx +1086 -0
package/docs/bundler/hot-reloading.mdx +229 -0
package/docs/bundler/html-static.mdx +498 -0
package/docs/bundler/index.mdx +1840 -0
package/docs/bundler/loaders.mdx +451 -0
package/docs/bundler/macros.mdx +328 -0
package/docs/bundler/minifier.mdx +1286 -0
package/docs/bundler/plugins.mdx +477 -0
package/docs/bundler/standalone-html.mdx +314 -0
package/docs/feedback.mdx +75 -0
package/docs/guides/binary/arraybuffer-to-array.mdx +29 -0
package/docs/guides/binary/arraybuffer-to-blob.mdx +26 -0
package/docs/guides/binary/arraybuffer-to-buffer.mdx +27 -0
package/docs/guides/binary/arraybuffer-to-string.mdx +17 -0
package/docs/guides/binary/arraybuffer-to-typedarray.mdx +41 -0
package/docs/guides/binary/blob-to-arraybuffer.mdx +16 -0
package/docs/guides/binary/blob-to-dataview.mdx +16 -0
package/docs/guides/binary/blob-to-stream.mdx +16 -0
package/docs/guides/binary/blob-to-string.mdx +17 -0
package/docs/guides/binary/blob-to-typedarray.mdx +16 -0
package/docs/guides/binary/buffer-to-arraybuffer.mdx +16 -0
package/docs/guides/binary/buffer-to-blob.mdx +16 -0
package/docs/guides/binary/buffer-to-readablestream.mdx +43 -0
package/docs/guides/binary/buffer-to-string.mdx +27 -0
package/docs/guides/binary/buffer-to-typedarray.mdx +16 -0
package/docs/guides/binary/dataview-to-string.mdx +17 -0
package/docs/guides/binary/typedarray-to-arraybuffer.mdx +27 -0
package/docs/guides/binary/typedarray-to-blob.mdx +18 -0
package/docs/guides/binary/typedarray-to-buffer.mdx +16 -0
package/docs/guides/binary/typedarray-to-dataview.mdx +16 -0
package/docs/guides/binary/typedarray-to-readablestream.mdx +43 -0
package/docs/guides/binary/typedarray-to-string.mdx +18 -0
package/docs/guides/deployment/aws-lambda.mdx +204 -0
package/docs/guides/deployment/digital-ocean.mdx +161 -0
package/docs/guides/deployment/google-cloud-run.mdx +194 -0
package/docs/guides/deployment/railway.mdx +145 -0
package/docs/guides/deployment/render.mdx +82 -0
package/docs/guides/deployment/vercel.mdx +97 -0
package/docs/guides/ecosystem/astro.mdx +82 -0
package/docs/guides/ecosystem/discordjs.mdx +80 -0
package/docs/guides/ecosystem/docker.mdx +151 -0
package/docs/guides/ecosystem/drizzle.mdx +195 -0
package/docs/guides/ecosystem/elysia.mdx +31 -0
package/docs/guides/ecosystem/express.mdx +43 -0
package/docs/guides/ecosystem/gel.mdx +261 -0
package/docs/guides/ecosystem/hono.mdx +47 -0
package/docs/guides/ecosystem/mongoose.mdx +92 -0
package/docs/guides/ecosystem/neon-drizzle.mdx +234 -0
package/docs/guides/ecosystem/neon-serverless-postgres.mdx +60 -0
package/docs/guides/ecosystem/nextjs.mdx +103 -0
package/docs/guides/ecosystem/nuxt.mdx +96 -0
package/docs/guides/ecosystem/pm2.mdx +55 -0
package/docs/guides/ecosystem/prisma-postgres.mdx +169 -0
package/docs/guides/ecosystem/prisma.mdx +164 -0
package/docs/guides/ecosystem/qwik.mdx +114 -0
package/docs/guides/ecosystem/react.mdx +52 -0
package/docs/guides/ecosystem/remix.mdx +97 -0
package/docs/guides/ecosystem/sentry.mdx +54 -0
package/docs/guides/ecosystem/solidstart.mdx +62 -0
package/docs/guides/ecosystem/ssr-react.mdx +49 -0
package/docs/guides/ecosystem/stric.mdx +54 -0
package/docs/guides/ecosystem/sveltekit.mdx +138 -0
package/docs/guides/ecosystem/systemd.mdx +114 -0
package/docs/guides/ecosystem/tanstack-start.mdx +791 -0
package/docs/guides/ecosystem/upstash.mdx +87 -0
package/docs/guides/ecosystem/vite.mdx +77 -0
package/docs/guides/html-rewriter/extract-links.mdx +71 -0
package/docs/guides/html-rewriter/extract-social-meta.mdx +97 -0
package/docs/guides/http/cluster.mdx +69 -0
package/docs/guides/http/fetch-unix.mdx +35 -0
package/docs/guides/http/fetch.mdx +26 -0
package/docs/guides/http/file-uploads.mdx +97 -0
package/docs/guides/http/hot.mdx +28 -0
package/docs/guides/http/proxy.mdx +50 -0
package/docs/guides/http/server.mdx +48 -0
package/docs/guides/http/simple.mdx +20 -0
package/docs/guides/http/sse.mdx +91 -0
package/docs/guides/http/stream-file.mdx +50 -0
package/docs/guides/http/stream-iterator.mdx +49 -0
package/docs/guides/http/stream-node-streams-in-bun.mdx +22 -0
package/docs/guides/http/tls.mdx +32 -0
package/docs/guides/index.mdx +10 -0
package/docs/guides/install/add-dev.mdx +28 -0
package/docs/guides/install/add-git.mdx +40 -0
package/docs/guides/install/add-optional.mdx +27 -0
package/docs/guides/install/add-peer.mdx +45 -0
package/docs/guides/install/add-tarball.mdx +35 -0
package/docs/guides/install/add.mdx +44 -0
package/docs/guides/install/azure-artifacts.mdx +76 -0
package/docs/guides/install/cicd.mdx +43 -0
package/docs/guides/install/custom-registry.mdx +32 -0
package/docs/guides/install/from-npm-install-to-bun-install.mdx +230 -0
package/docs/guides/install/git-diff-bun-lockfile.mdx +48 -0
package/docs/guides/install/jfrog-artifactory.mdx +28 -0
package/docs/guides/install/npm-alias.mdx +25 -0
package/docs/guides/install/registry-scope.mdx +40 -0
package/docs/guides/install/trusted.mdx +52 -0
package/docs/guides/install/workspaces.mdx +70 -0
package/docs/guides/install/yarnlock.mdx +51 -0
package/docs/guides/process/argv.mdx +66 -0
package/docs/guides/process/ctrl-c.mdx +18 -0
package/docs/guides/process/ipc.mdx +69 -0
package/docs/guides/process/nanoseconds.mdx +15 -0
package/docs/guides/process/os-signals.mdx +31 -0
package/docs/guides/process/spawn-stderr.mdx +34 -0
package/docs/guides/process/spawn-stdout.mdx +28 -0
package/docs/guides/process/spawn.mdx +43 -0
package/docs/guides/process/stdin.mdx +62 -0
package/docs/guides/read-file/arraybuffer.mdx +30 -0
package/docs/guides/read-file/buffer.mdx +21 -0
package/docs/guides/read-file/exists.mdx +18 -0
package/docs/guides/read-file/json.mdx +19 -0
package/docs/guides/read-file/mime.mdx +22 -0
package/docs/guides/read-file/stream.mdx +28 -0
package/docs/guides/read-file/string.mdx +24 -0
package/docs/guides/read-file/uint8array.mdx +23 -0
package/docs/guides/read-file/watch.mdx +66 -0
package/docs/guides/runtime/build-time-constants.mdx +295 -0
package/docs/guides/runtime/cicd.mdx +45 -0
package/docs/guides/runtime/codesign-macos-executable.mdx +61 -0
package/docs/guides/runtime/define-constant.mdx +149 -0
package/docs/guides/runtime/delete-directory.mdx +39 -0
package/docs/guides/runtime/delete-file.mdx +21 -0
package/docs/guides/runtime/heap-snapshot.mdx +28 -0
package/docs/guides/runtime/import-html.mdx +15 -0
package/docs/guides/runtime/import-json.mdx +46 -0
package/docs/guides/runtime/import-json5.mdx +74 -0
package/docs/guides/runtime/import-toml.mdx +32 -0
package/docs/guides/runtime/import-yaml.mdx +104 -0
package/docs/guides/runtime/read-env.mdx +37 -0
package/docs/guides/runtime/set-env.mdx +51 -0
package/docs/guides/runtime/shell.mdx +42 -0
package/docs/guides/runtime/timezone.mdx +38 -0
package/docs/guides/runtime/tsconfig-paths.mdx +31 -0
package/docs/guides/runtime/typescript.mdx +51 -0
package/docs/guides/runtime/vscode-debugger.mdx +47 -0
package/docs/guides/runtime/web-debugger.mdx +103 -0
package/docs/guides/streams/node-readable-to-arraybuffer.mdx +13 -0
package/docs/guides/streams/node-readable-to-blob.mdx +13 -0
package/docs/guides/streams/node-readable-to-json.mdx +14 -0
package/docs/guides/streams/node-readable-to-string.mdx +14 -0
package/docs/guides/streams/node-readable-to-uint8array.mdx +13 -0
package/docs/guides/streams/to-array.mdx +16 -0
package/docs/guides/streams/to-arraybuffer.mdx +16 -0
package/docs/guides/streams/to-blob.mdx +16 -0
package/docs/guides/streams/to-buffer.mdx +17 -0
package/docs/guides/streams/to-json.mdx +16 -0
package/docs/guides/streams/to-string.mdx +16 -0
package/docs/guides/streams/to-typedarray.mdx +24 -0
package/docs/guides/test/bail.mdx +24 -0
package/docs/guides/test/concurrent-test-glob.mdx +146 -0
package/docs/guides/test/coverage-threshold.mdx +67 -0
package/docs/guides/test/coverage.mdx +49 -0
package/docs/guides/test/happy-dom.mdx +73 -0
package/docs/guides/test/migrate-from-jest.mdx +125 -0
package/docs/guides/test/mock-clock.mdx +50 -0
package/docs/guides/test/mock-functions.mdx +70 -0
package/docs/guides/test/rerun-each.mdx +16 -0
package/docs/guides/test/run-tests.mdx +116 -0
package/docs/guides/test/skip-tests.mdx +43 -0
package/docs/guides/test/snapshot.mdx +102 -0
package/docs/guides/test/spy-on.mdx +49 -0
package/docs/guides/test/svelte-test.mdx +113 -0
package/docs/guides/test/testing-library.mdx +93 -0
package/docs/guides/test/timeout.mdx +17 -0
package/docs/guides/test/todo-tests.mdx +74 -0
package/docs/guides/test/update-snapshots.mdx +49 -0
package/docs/guides/test/watch-mode.mdx +24 -0
package/docs/guides/util/base64.mdx +17 -0
package/docs/guides/util/deep-equals.mdx +41 -0
package/docs/guides/util/deflate.mdx +20 -0
package/docs/guides/util/detect-bun.mdx +28 -0
package/docs/guides/util/entrypoint.mdx +19 -0
package/docs/guides/util/escape-html.mdx +24 -0
package/docs/guides/util/file-url-to-path.mdx +16 -0
package/docs/guides/util/gzip.mdx +20 -0
package/docs/guides/util/hash-a-password.mdx +56 -0
package/docs/guides/util/import-meta-dir.mdx +15 -0
package/docs/guides/util/import-meta-file.mdx +15 -0
package/docs/guides/util/import-meta-path.mdx +15 -0
package/docs/guides/util/javascript-uuid.mdx +25 -0
package/docs/guides/util/main.mdx +43 -0
package/docs/guides/util/path-to-file-url.mdx +16 -0
package/docs/guides/util/sleep.mdx +24 -0
package/docs/guides/util/upgrade.mdx +93 -0
package/docs/guides/util/version.mdx +23 -0
package/docs/guides/util/which-path-to-executable-bin.mdx +17 -0
package/docs/guides/websocket/compression.mdx +33 -0
package/docs/guides/websocket/context.mdx +79 -0
package/docs/guides/websocket/pubsub.mdx +43 -0
package/docs/guides/websocket/simple.mdx +38 -0
package/docs/guides/write-file/append.mdx +54 -0
package/docs/guides/write-file/basic.mdx +46 -0
package/docs/guides/write-file/blob.mdx +30 -0
package/docs/guides/write-file/cat.mdx +19 -0
package/docs/guides/write-file/file-cp.mdx +18 -0
package/docs/guides/write-file/filesink.mdx +54 -0
package/docs/guides/write-file/response.mdx +19 -0
package/docs/guides/write-file/stdout.mdx +23 -0
package/docs/guides/write-file/stream.mdx +19 -0
package/docs/guides/write-file/unlink.mdx +18 -0
package/docs/index.mdx +133 -0
package/docs/installation.mdx +372 -0
package/docs/pm/bunx.mdx +91 -0
package/docs/pm/catalogs.mdx +292 -0
package/docs/pm/cli/add.mdx +179 -0
package/docs/pm/cli/audit.mdx +60 -0
package/docs/pm/cli/info.mdx +70 -0
package/docs/pm/cli/install.mdx +591 -0
package/docs/pm/cli/link.mdx +61 -0
package/docs/pm/cli/outdated.mdx +197 -0
package/docs/pm/cli/patch.mdx +69 -0
package/docs/pm/cli/pm.mdx +323 -0
package/docs/pm/cli/publish.mdx +131 -0
package/docs/pm/cli/remove.mdx +16 -0
package/docs/pm/cli/update.mdx +140 -0
package/docs/pm/cli/why.mdx +84 -0
package/docs/pm/filter.mdx +127 -0
package/docs/pm/global-cache.mdx +72 -0
package/docs/pm/isolated-installs.mdx +220 -0
package/docs/pm/lifecycle.mdx +64 -0
package/docs/pm/lockfile.mdx +64 -0
package/docs/pm/npmrc.mdx +245 -0
package/docs/pm/overrides.mdx +83 -0
package/docs/pm/scopes-registries.mdx +35 -0
package/docs/pm/security-scanner-api.mdx +95 -0
package/docs/pm/workspaces.mdx +115 -0
package/docs/project/benchmarking.mdx +296 -0
package/docs/project/bindgen.mdx +223 -0
package/docs/project/building-windows.mdx +143 -0
package/docs/project/contributing.mdx +366 -0
package/docs/project/feedback.mdx +20 -0
package/docs/project/license.mdx +78 -0
package/docs/project/roadmap.mdx +8 -0
package/docs/quickstart.mdx +251 -0
package/docs/runtime/archive.mdx +452 -0
package/docs/runtime/auto-install.mdx +97 -0
package/docs/runtime/binary-data.mdx +846 -0
package/docs/runtime/bun-apis.mdx +60 -0
package/docs/runtime/bunfig.mdx +765 -0
package/docs/runtime/c-compiler.mdx +204 -0
package/docs/runtime/child-process.mdx +659 -0
package/docs/runtime/color.mdx +267 -0
package/docs/runtime/console.mdx +67 -0
package/docs/runtime/cookies.mdx +454 -0
package/docs/runtime/cron.mdx +358 -0
package/docs/runtime/csrf.mdx +171 -0
package/docs/runtime/debugger.mdx +335 -0
package/docs/runtime/environment-variables.mdx +231 -0
package/docs/runtime/ffi.mdx +567 -0
package/docs/runtime/file-io.mdx +306 -0
package/docs/runtime/file-system-router.mdx +118 -0
package/docs/runtime/file-types.mdx +482 -0
package/docs/runtime/glob.mdx +181 -0
package/docs/runtime/globals.mdx +72 -0
package/docs/runtime/hashing.mdx +315 -0
package/docs/runtime/html-rewriter.mdx +333 -0
package/docs/runtime/http/cookies.mdx +79 -0
package/docs/runtime/http/error-handling.mdx +40 -0
package/docs/runtime/http/metrics.mdx +36 -0
package/docs/runtime/http/routing.mdx +289 -0
package/docs/runtime/http/server.mdx +672 -0
package/docs/runtime/http/tls.mdx +101 -0
package/docs/runtime/http/websockets.mdx +414 -0
package/docs/runtime/index.mdx +223 -0
package/docs/runtime/json5.mdx +271 -0
package/docs/runtime/jsonl.mdx +188 -0
package/docs/runtime/jsx.mdx +115 -0
package/docs/runtime/markdown.mdx +381 -0
package/docs/runtime/module-resolution.mdx +374 -0
package/docs/runtime/networking/dns.mdx +111 -0
package/docs/runtime/networking/fetch.mdx +484 -0
package/docs/runtime/networking/tcp.mdx +239 -0
package/docs/runtime/networking/udp.mdx +180 -0
package/docs/runtime/node-api.mdx +19 -0
package/docs/runtime/nodejs-compat.mdx +468 -0
package/docs/runtime/plugins.mdx +419 -0
package/docs/runtime/redis.mdx +583 -0
package/docs/runtime/repl.mdx +176 -0
package/docs/runtime/s3.mdx +881 -0
package/docs/runtime/secrets.mdx +340 -0
package/docs/runtime/semver.mdx +57 -0
package/docs/runtime/shell.mdx +637 -0
package/docs/runtime/sql.mdx +1404 -0
package/docs/runtime/sqlite.mdx +721 -0
package/docs/runtime/streams.mdx +232 -0
package/docs/runtime/templating/create.mdx +269 -0
package/docs/runtime/templating/init.mdx +58 -0
package/docs/runtime/toml.mdx +238 -0
package/docs/runtime/transpiler.mdx +288 -0
package/docs/runtime/typescript.mdx +58 -0
package/docs/runtime/utils.mdx +1010 -0
package/docs/runtime/watch-mode.mdx +161 -0
package/docs/runtime/web-apis.mdx +29 -0
package/docs/runtime/workers.mdx +314 -0
package/docs/runtime/yaml.mdx +470 -0
package/docs/snippets/cli/add.mdx +166 -0
package/docs/snippets/cli/build.mdx +197 -0
package/docs/snippets/cli/bunx.mdx +49 -0
package/docs/snippets/cli/feedback.mdx +17 -0
package/docs/snippets/cli/init.mdx +84 -0
package/docs/snippets/cli/install.mdx +173 -0
package/docs/snippets/cli/link.mdx +163 -0
package/docs/snippets/cli/outdated.mdx +140 -0
package/docs/snippets/cli/patch.mdx +171 -0
package/docs/snippets/cli/publish.mdx +198 -0
package/docs/snippets/cli/remove.mdx +146 -0
package/docs/snippets/cli/run.mdx +305 -0
package/docs/snippets/cli/test.mdx +105 -0
package/docs/snippets/cli/update.mdx +144 -0
package/docs/test/code-coverage.mdx +409 -0
package/docs/test/configuration.mdx +574 -0
package/docs/test/dates-times.mdx +129 -0
package/docs/test/discovery.mdx +90 -0
package/docs/test/dom.mdx +226 -0
package/docs/test/index.mdx +409 -0
package/docs/test/lifecycle.mdx +366 -0
package/docs/test/mocks.mdx +637 -0
package/docs/test/reporters.mdx +126 -0
package/docs/test/runtime-behavior.mdx +342 -0
package/docs/test/snapshots.mdx +434 -0
package/docs/test/writing-tests.mdx +672 -0
package/docs/typescript.mdx +54 -0
package/extensions.d.ts +40 -0
package/fetch.d.ts +79 -0
package/ffi.d.ts +1154 -0
package/globals.d.ts +2067 -0
package/html-rewriter.d.ts +186 -0
package/index.d.ts +32 -0
package/jsc.d.ts +233 -0
package/jsx.d.ts +11 -0
package/overrides.d.ts +376 -0
package/package.json +53 -0
package/redis.d.ts +3352 -0
package/s3.d.ts +1354 -0
package/security.d.ts +101 -0
package/serve.d.ts +1296 -0
package/shell.d.ts +380 -0
package/sql.d.ts +887 -0
package/sqlite.d.ts +1322 -0
package/test-globals.d.ts +22 -0
package/test.d.ts +2392 -0
package/vendor/expect-type/branding.d.ts +283 -0
package/vendor/expect-type/index.d.ts +1207 -0
package/vendor/expect-type/messages.d.ts +395 -0
package/vendor/expect-type/overloads.d.ts +669 -0
package/vendor/expect-type/utils.d.ts +431 -0
package/wasm.d.ts +193 -0

package/docs/runtime/jsx.mdx ADDED Viewed

@@ -0,0 +1,115 @@
+---
+title: "JSX"
+description: "Built-in JSX and TSX support in Bun with configurable transpilation options"
+---
+Bun supports `.jsx` and `.tsx` files out of the box. Bun's internal transpiler converts JSX syntax into vanilla JavaScript before execution.
+```ts react.tsx icon="/icons/typescript.svg"
+function Component(props: {message: string}) {
+  return (
+    <body>
+      <h1 style={{color: 'red'}}>{props.message}</h1>
+    </body>
+  );
+}
+console.log(<Component message="Hello world!" />);
+```
+## Configuration
+Bun reads your `tsconfig.json` or `jsconfig.json` configuration files to determines how to perform the JSX transform internally. To avoid using either of these, the following options can also be defined in [`bunfig.toml`](/docs/runtime/bunfig).
+The following compiler options are respected.
+### [`jsx`](https://www.typescriptlang.org/tsconfig#jsx)
+How JSX constructs are transformed into vanilla JavaScript internally. The table below lists the possible values of `jsx`, along with their transpilation of the following simple JSX component:
+```tsx
+<Box width={5}>Hello</Box>
+```
+| Compiler options                                    | Transpiled output                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `json<br/>{<br/>  "jsx": "react"<br/>}<br/>`        | `tsx<br/>import { createElement } from "react";<br/>createElement("Box", { width: 5 }, "Hello");<br/>`                                                                                                                                                                                                                                                                                                                                                                    |
+| `json<br/>{<br/>  "jsx": "react-jsx"<br/>}<br/>`    | `tsx<br/>import { jsx } from "react/jsx-runtime";<br/>jsx("Box", { width: 5 }, "Hello");<br/>`                                                                                                                                                                                                                                                                                                                                                                            |
+| `json<br/>{<br/>  "jsx": "react-jsxdev"<br/>}<br/>` | `tsx<br/>import { jsxDEV } from "react/jsx-dev-runtime";<br/>jsxDEV(<br/>  "Box",<br/>  { width: 5, children: "Hello" },<br/>  undefined,<br/>  false,<br/>  undefined,<br/>  this,<br/>);<br/>`<br/><br/>The `jsxDEV` variable name is a convention used by React. The `DEV` suffix is a visible way to indicate that the code is intended for use in development. The development version of React is slower and includes additional validity checks & debugging tools. |
+| `json<br/>{<br/>  "jsx": "preserve"<br/>}<br/>`     | `tsx<br/>// JSX is not transpiled<br/>// "preserve" is not supported by Bun currently<br/><Box width={5}>Hello</Box><br/>`                                                                                                                                                                                                                                                                                                                                                |
+### [`jsxFactory`](https://www.typescriptlang.org/tsconfig#jsxFactory)
+<Note>**Note** — Only applicable when `jsx` is `react`.</Note>
+The function name used to represent JSX constructs. Default value is `"createElement"`. This is useful for libraries like [Preact](https://preactjs.com/) that use a different function name (`"h"`).
+| Compiler options                                                      | Transpiled output                                                              |
+| --------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| `json<br/>{<br/>  "jsx": "react",<br/>  "jsxFactory": "h"<br/>}<br/>` | `tsx<br/>import { h } from "react";<br/>h("Box", { width: 5 }, "Hello");<br/>` |
+### [`jsxFragmentFactory`](https://www.typescriptlang.org/tsconfig#jsxFragmentFactory)
+<Note>**Note** — Only applicable when `jsx` is `react`.</Note>
+The function name used to represent [JSX fragments](https://react.dev/reference/react/Fragment) such as `<>Hello</>`; only applicable when `jsx` is `react`. Default value is `"Fragment"`.
+| Compiler options                                                                                                    | Transpiled output                                                                                                                               |
+| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `json<br/>{<br/>  "jsx": "react",<br/>  "jsxFactory": "myjsx",<br/>  "jsxFragmentFactory": "MyFragment"<br/>}<br/>` | `tsx<br/>// input<br/><>Hello</>;<br/><br/>// output<br/>import { myjsx, MyFragment } from "react";<br/>myjsx(MyFragment, null, "Hello");<br/>` |
+### [`jsxImportSource`](https://www.typescriptlang.org/tsconfig#jsxImportSource)
+<Note>**Note** — Only applicable when `jsx` is `react-jsx` or `react-jsxdev`.</Note>
+The module from which the component factory function (`createElement`, `jsx`, `jsxDEV`, etc) will be imported. Default value is `"react"`. This will typically be necessary when using a component library like Preact.
+| Compiler options                                                                                                   | Transpiled output                                                                                                                                                                                                                               |
+| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `jsonc<br/>{<br/>  "jsx": "react",<br/>  // jsxImportSource is not defined<br/>  // default to "react"<br/>}<br/>` | `tsx<br/>import { jsx } from "react/jsx-runtime";<br/>jsx("Box", { width: 5, children: "Hello" });<br/>`                                                                                                                                        |
+| `jsonc<br/>{<br/>  "jsx": "react-jsx",<br/>  "jsxImportSource": "preact",<br/>}<br/>`                              | `tsx<br/>import { jsx } from "preact/jsx-runtime";<br/>jsx("Box", { width: 5, children: "Hello" });<br/>`                                                                                                                                       |
+| `jsonc<br/>{<br/>  "jsx": "react-jsxdev",<br/>  "jsxImportSource": "preact",<br/>}<br/>`                           | `tsx<br/>// /jsx-runtime is automatically appended<br/>import { jsxDEV } from "preact/jsx-dev-runtime";<br/>jsxDEV(<br/>  "Box",<br/>  { width: 5, children: "Hello" },<br/>  undefined,<br/>  false,<br/>  undefined,<br/>  this,<br/>);<br/>` |
+### JSX pragma
+All of these values can be set on a per-file basis using _pragmas_. A pragma is a special comment that sets a compiler option in a particular file.
+| Pragma                                   | Equivalent config                                                  |
+| ---------------------------------------- | ------------------------------------------------------------------ |
+| `ts<br/>// @jsx h<br/>`                  | `jsonc<br/>{<br/>  "jsxFactory": "h",<br/>}<br/>`                  |
+| `ts<br/>// @jsxFrag MyFragment<br/>`     | `jsonc<br/>{<br/>  "jsxFragmentFactory": "MyFragment",<br/>}<br/>` |
+| `ts<br/>// @jsxImportSource preact<br/>` | `jsonc<br/>{<br/>  "jsxImportSource": "preact",<br/>}<br/>`        |
+## Logging
+Bun implements special logging for JSX to make debugging easier. Given the following file:
+```tsx index.tsx icon="/icons/typescript.svg"
+import { Stack, UserCard } from "./components";
+console.log(
+  <Stack>
+    <UserCard name="Dom" bio="Street racer and Corona lover" />
+    <UserCard name="Jakob" bio="Super spy and Dom's secret brother" />
+  </Stack>,
+);
+```
+Bun will pretty-print the component tree when logged:
+<Frame>![JSX logging output](https://github.com/oven-sh/bun/assets/3084745/d29db51d-6837-44e2-b8be-84fc1b9e9d97)</Frame>
+## Prop punning
+The Bun runtime also supports "prop punning" for JSX. This is a shorthand syntax useful for assigning a variable to a prop with the same name.
+```tsx react.tsx icon="/icons/typescript.svg"
+function Div(props: {className: string;}) {
+  const {className} = props;
+  // without punning
+  return <div className={className} />;
+  // with punning
+  return <div {className} />;
+}
+```

package/docs/runtime/markdown.mdx ADDED Viewed

@@ -0,0 +1,381 @@
+---
+title: Markdown
+description: Parse and render Markdown with Bun's built-in Markdown API, supporting GFM extensions and custom rendering callbacks
+---
+<Callout type="note">
+  **Unstable API** — This API is under active development and may change in future versions of Bun.
+</Callout>
+Bun includes a fast, built-in Markdown parser written in Zig. It supports GitHub Flavored Markdown (GFM) extensions and provides three APIs:
+- `Bun.markdown.html()` — render Markdown to an HTML string
+- `Bun.markdown.render()` — render Markdown with custom callbacks for each element
+- `Bun.markdown.react()` — render Markdown to React JSX elements
+---
+## `Bun.markdown.html()`
+Convert a Markdown string to HTML.
+```ts
+const html = Bun.markdown.html("# Hello **world**");
+// "<h1>Hello <strong>world</strong></h1>\n"
+```
+GFM extensions like tables, strikethrough, and task lists are enabled by default:
+```ts
+const html = Bun.markdown.html(`
+| Feature      | Status |
+|-------------|--------|
+| Tables       | ~~done~~ |
+| Strikethrough| ~~done~~ |
+| Task lists   | done |
+`);
+```
+### Options
+Pass an options object as the second argument to configure the parser:
+```ts
+const html = Bun.markdown.html("some markdown", {
+  tables: true, // GFM tables (default: true)
+  strikethrough: true, // GFM strikethrough (default: true)
+  tasklists: true, // GFM task lists (default: true)
+  tagFilter: true, // GFM tag filter for disallowed HTML tags
+  autolinks: true, // Autolink URLs, emails, and www. links
+});
+```
+All available options:
+| Option                 | Default | Description                                                 |
+| ---------------------- | ------- | ----------------------------------------------------------- |
+| `tables`               | `false` | GFM tables                                                  |
+| `strikethrough`        | `false` | GFM strikethrough (`~~text~~`)                              |
+| `tasklists`            | `false` | GFM task lists (`- [x] item`)                               |
+| `autolinks`            | `false` | Enable autolinks — see [Autolinks](#autolinks)              |
+| `headings`             | `false` | Heading IDs and autolinks — see [Heading IDs](#heading-ids) |
+| `hardSoftBreaks`       | `false` | Treat soft line breaks as hard breaks                       |
+| `wikiLinks`            | `false` | Enable `[[wiki links]]`                                     |
+| `underline`            | `false` | `__text__` renders as `<u>` instead of `<strong>`           |
+| `latexMath`            | `false` | Enable `$inline$` and `$$display$$` math                    |
+| `collapseWhitespace`   | `false` | Collapse whitespace in text                                 |
+| `permissiveAtxHeaders` | `false` | ATX headers without space after `#`                         |
+| `noIndentedCodeBlocks` | `false` | Disable indented code blocks                                |
+| `noHtmlBlocks`         | `false` | Disable HTML blocks                                         |
+| `noHtmlSpans`          | `false` | Disable inline HTML                                         |
+| `tagFilter`            | `false` | GFM tag filter for disallowed HTML tags                     |
+#### Autolinks
+Pass `true` to enable all autolink types, or an object for granular control:
+```ts
+// Enable all autolinks (URL, WWW, email)
+Bun.markdown.html("Visit www.example.com", { autolinks: true });
+// Enable only specific types
+Bun.markdown.html("Visit www.example.com", {
+  autolinks: { url: true, www: true },
+});
+```
+#### Heading IDs
+Pass `true` to enable both heading IDs and autolink headings, or an object for granular control:
+```ts
+// Enable heading IDs and autolink headings
+Bun.markdown.html("## Hello World", { headings: true });
+// '<h2 id="hello-world"><a href="#hello-world">Hello World</a></h2>\n'
+// Enable only heading IDs (no autolink)
+Bun.markdown.html("## Hello World", { headings: { ids: true } });
+// '<h2 id="hello-world">Hello World</h2>\n'
+```
+---
+## `Bun.markdown.render()`
+Parse Markdown and render it using custom JavaScript callbacks. This gives you full control over the output format — you can generate HTML with custom classes, React elements, ANSI terminal output, or any other string format.
+```ts
+const result = Bun.markdown.render("# Hello **world**", {
+  heading: (children, { level }) => `<h${level} class="title">${children}</h${level}>`,
+  strong: children => `<b>${children}</b>`,
+  paragraph: children => `<p>${children}</p>`,
+});
+// '<h1 class="title">Hello <b>world</b></h1>'
+```
+### Callback signature
+Each callback receives:
+1. **`children`** — the accumulated content of the element as a string
+2. **`meta`** (optional) — an object with element-specific metadata
+Return a string to replace the element's rendering. Return `null` or `undefined` to omit the element from the output entirely. If no callback is registered for an element, its children pass through unchanged.
+### Block callbacks
+| Callback     | Meta                                          | Description                                                                              |
+| ------------ | --------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `heading`    | `{ level, id? }`                              | Heading level 1–6. `id` is set when `headings: { ids: true }` is enabled                 |
+| `paragraph`  | —                                             | Paragraph block                                                                          |
+| `blockquote` | —                                             | Blockquote block                                                                         |
+| `code`       | `{ language? }`                               | Fenced or indented code block. `language` is the info-string when specified on the fence |
+| `list`       | `{ ordered, start?, depth }`                  | `depth` is nesting level (0 = top-level). `start` is set for ordered lists               |
+| `listItem`   | `{ index, depth, ordered, start?, checked? }` | See [List item meta](#list-item-meta) below                                              |
+| `hr`         | —                                             | Horizontal rule                                                                          |
+| `table`      | —                                             | Table block                                                                              |
+| `thead`      | —                                             | Table head                                                                               |
+| `tbody`      | —                                             | Table body                                                                               |
+| `tr`         | —                                             | Table row                                                                                |
+| `th`         | `{ align? }`                                  | Table header cell. `align` is `"left"`, `"center"`, `"right"`, or absent                 |
+| `td`         | `{ align? }`                                  | Table data cell                                                                          |
+| `html`       | —                                             | Raw HTML content                                                                         |
+#### List item meta
+The `listItem` callback receives everything needed to render markers directly:
+- `index` — 0-based position within the parent list
+- `depth` — the parent list's nesting level (0 = top-level)
+- `ordered` — whether the parent list is ordered
+- `start` — the parent list's start number (only when `ordered` is true)
+- `checked` — task list state (only for `- [x]` / `- [ ]` items)
+### Inline callbacks
+| Callback        | Meta                               | Description                  |
+| --------------- | ---------------------------------- | ---------------------------- |
+| `strong`        | —                                  | Strong emphasis (`**text**`) |
+| `emphasis`      | —                                  | Emphasis (`*text*`)          |
+| `link`          | `{ href: string, title?: string }` | Link                         |
+| `image`         | `{ src: string, title?: string }`  | Image                        |
+| `codespan`      | —                                  | Inline code (`` `code` ``)   |
+| `strikethrough` | —                                  | Strikethrough (`~~text~~`)   |
+| `text`          | —                                  | Plain text content           |
+### Examples
+#### Custom HTML with classes
+```ts
+const html = Bun.markdown.render("# Title\n\nHello **world**", {
+  heading: (children, { level }) => `<h${level} class="heading heading-${level}">${children}</h${level}>`,
+  paragraph: children => `<p class="body">${children}</p>`,
+  strong: children => `<strong class="bold">${children}</strong>`,
+});
+```
+#### Stripping all formatting
+```ts
+const plaintext = Bun.markdown.render("# Hello **world**", {
+  heading: children => children,
+  paragraph: children => children,
+  strong: children => children,
+  emphasis: children => children,
+  link: children => children,
+  image: () => "",
+  code: children => children,
+  codespan: children => children,
+});
+// "Hello world"
+```
+#### Omitting elements
+Return `null` or `undefined` to remove an element from the output:
+```ts
+const result = Bun.markdown.render("# Title\n\n![logo](img.png)\n\nHello", {
+  image: () => null, // Remove all images
+  heading: children => children,
+  paragraph: children => children + "\n",
+});
+// "Title\nHello\n"
+```
+#### ANSI terminal output
+```ts
+const ansi = Bun.markdown.render("# Hello\n\nThis is **bold** and *italic*", {
+  heading: (children, { level }) => `\x1b[1;4m${children}\x1b[0m\n`,
+  paragraph: children => children + "\n",
+  strong: children => `\x1b[1m${children}\x1b[22m`,
+  emphasis: children => `\x1b[3m${children}\x1b[23m`,
+});
+```
+#### Nested list numbering
+The `listItem` callback receives everything needed to render markers directly — no post-processing:
+```ts
+const result = Bun.markdown.render("1. first\n   1. sub-a\n   2. sub-b\n2. second", {
+  listItem: (children, { index, depth, ordered, start }) => {
+    const n = (start ?? 1) + index;
+    // 1. 2. 3. at depth 0, a. b. c. at depth 1, i. ii. iii. at depth 2
+    const marker = !ordered
+      ? "-"
+      : depth === 0
+        ? `${n}.`
+        : depth === 1
+          ? `${String.fromCharCode(96 + n)}.`
+          : `${toRoman(n)}.`;
+    return "  ".repeat(depth) + marker + " " + children.trimEnd() + "\n";
+  },
+  // Prepend a newline so nested lists are separated from their parent item's text
+  list: children => "\n" + children,
+});
+// 1. first
+//   a. sub-a
+//   b. sub-b
+// 2. second
+```
+#### Code block syntax highlighting
+````ts
+const result = Bun.markdown.render("```js\nconsole.log('hi')\n```", {
+  code: (children, meta) => {
+    const lang = meta?.language ?? "";
+    return `<pre><code class="language-${lang}">${children}</code></pre>`;
+  },
+});
+````
+### Parser options
+Parser options are passed as a separate third argument:
+```ts
+const result = Bun.markdown.render(
+  "Visit www.example.com",
+  {
+    link: (children, { href }) => `[${children}](${href})`,
+    paragraph: children => children,
+  },
+  { autolinks: true },
+);
+```
+---
+## `Bun.markdown.react()`
+Render Markdown directly to React elements. Returns a `<Fragment>` that you can use as a component return value.
+```tsx
+function Markdown({ text }: { text: string }) {
+  return Bun.markdown.react(text);
+}
+```
+### Server-side rendering
+Works with `renderToString()` and React Server Components:
+```tsx
+import { renderToString } from "react-dom/server";
+const html = renderToString(Bun.markdown.react("# Hello **world**"));
+// "<h1>Hello <strong>world</strong></h1>"
+```
+### Component overrides
+Replace any HTML element with a custom React component by passing it in the second argument, keyed by tag name:
+```tsx
+function Code({ language, children }) {
+  return (
+    <pre data-language={language}>
+      <code>{children}</code>
+    </pre>
+  );
+}
+function Link({ href, title, children }) {
+  return (
+    <a href={href} title={title} target="_blank" rel="noopener noreferrer">
+      {children}
+    </a>
+  );
+}
+function Heading({ id, children }) {
+  return (
+    <h2 id={id}>
+      <a href={`#${id}`}>{children}</a>
+    </h2>
+  );
+}
+const el = Bun.markdown.react(
+  content,
+  {
+    pre: Code,
+    a: Link,
+    h2: Heading,
+  },
+  { headings: { ids: true } },
+);
+```
+#### Available overrides
+Every HTML tag produced by the parser can be overridden:
+| Option       | Props                        | Description                                                     |
+| ------------ | ---------------------------- | --------------------------------------------------------------- |
+| `h1`–`h6`    | `{ id?, children }`          | Headings. `id` is set when `headings: { ids: true }` is enabled |
+| `p`          | `{ children }`               | Paragraph                                                       |
+| `blockquote` | `{ children }`               | Blockquote                                                      |
+| `pre`        | `{ language?, children }`    | Code block. `language` is the info string (e.g. `"js"`)         |
+| `hr`         | `{}`                         | Horizontal rule (no children)                                   |
+| `ul`         | `{ children }`               | Unordered list                                                  |
+| `ol`         | `{ start, children }`        | Ordered list. `start` is the first item number                  |
+| `li`         | `{ checked?, children }`     | List item. `checked` is set for task list items                 |
+| `table`      | `{ children }`               | Table                                                           |
+| `thead`      | `{ children }`               | Table head                                                      |
+| `tbody`      | `{ children }`               | Table body                                                      |
+| `tr`         | `{ children }`               | Table row                                                       |
+| `th`         | `{ align?, children }`       | Table header cell                                               |
+| `td`         | `{ align?, children }`       | Table data cell                                                 |
+| `em`         | `{ children }`               | Emphasis (`*text*`)                                             |
+| `strong`     | `{ children }`               | Strong (`**text**`)                                             |
+| `a`          | `{ href, title?, children }` | Link                                                            |
+| `img`        | `{ src, alt?, title? }`      | Image (no children)                                             |
+| `code`       | `{ children }`               | Inline code                                                     |
+| `del`        | `{ children }`               | Strikethrough (`~~text~~`)                                      |
+| `br`         | `{}`                         | Hard line break (no children)                                   |
+### React 18 and older
+By default, elements use `Symbol.for('react.transitional.element')` as the `$$typeof` symbol. For React 18 and older, pass `reactVersion: 18` in the options (third argument):
+```tsx
+function Markdown({ text }: { text: string }) {
+  return Bun.markdown.react(text, undefined, { reactVersion: 18 });
+}
+```
+### Parser options
+All [parser options](#options) are passed as the third argument:
+```tsx
+const el = Bun.markdown.react("## Hello World", undefined, {
+  headings: { ids: true },
+  autolinks: true,
+});
+```