bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/{bundler/loaders.md → runtime/file-types.mdx}

@@ -1,8 +1,13 @@
+---
+title: "File Types"
+description: "File types and loaders supported by Bun's bundler and runtime"
+---
+
 The Bun bundler implements a set of default loaders out of the box. As a rule of thumb, the bundler and the runtime both support the same set of file types out of the box.
 
-`.js` `.cjs` `.mjs` `.mts` `.cts` `.ts` `.tsx` `.jsx` `.toml` `.json` `.yaml` `.yml` `.txt` `.wasm` `.node` `.html`
+`.js` `.cjs` `.mjs` `.mts` `.cts` `.ts` `.tsx` `.jsx` `.toml` `.json` `.txt` `.wasm` `.node` `.html`
 
-Bun uses the file extension to determine which built-in _loader_ should be used to parse the file. Every loader has a name, such as `js`, `tsx`, or `json`. These names are used when building [plugins](https://bun.com/docs/bundler/plugins) that extend Bun with custom loaders.
+Bun uses the file extension to determine which built-in _loader_ should be used to parse the file. Every loader has a name, such as `js`, `tsx`, or `json`. These names are used when building [plugins](/bundler/plugins) that extend Bun with custom loaders.
 
 You can explicitly specify which loader to use using the 'loader' import attribute.
 
@@ -10,6 +15,8 @@ You can explicitly specify which loader to use using the 'loader' import attribu
 import my_toml from "./my_file" with { loader: "toml" };
 ```
 
+---
+
 ## Built-in loaders
 
 ### `js`
@@ -57,9 +64,9 @@ pkg.name;
 
 If a `.json` file is passed as an entrypoint to the bundler, it will be converted to a `.js` module that `export default`s the parsed object.
 
-{% codetabs %}
+<CodeGroup>
 
-```json#Input
+```json Input
 {
   "name": "John Doe",
   "age": 35,
@@ -67,15 +74,15 @@ If a `.json` file is passed as an entrypoint to the bundler, it will be converte
 }
 ```
 
-```js#Output
+```ts Output
 export default {
   name: "John Doe",
   age: 35,
-  email: "johndoe@example.com"
-}
+  email: "johndoe@example.com",
+};
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 ### `toml`
 
@@ -103,72 +110,23 @@ config.logLevel;
 
 If a `.toml` file is passed as an entrypoint, it will be converted to a `.js` module that `export default`s the parsed object.
 
-{% codetabs %}
+<CodeGroup>
 
-```toml#Input
+```toml Input
 name = "John Doe"
 age = 35
 email = "johndoe@example.com"
 ```
 
-```js#Output
+```ts Output
 export default {
   name: "John Doe",
   age: 35,
-  email: "johndoe@example.com"
-}
-```
-
-{% /codetabs %}
-
-### `yaml`
-
-**YAML loader**. Default for `.yaml` and `.yml`.
-
-YAML files can be directly imported. Bun will parse them with its fast native YAML parser.
-
-```ts
-import config from "./config.yaml";
-config.database.host; // => "localhost"
-
-// via import attribute:
-// import myCustomYAML from './my.config' with {type: "yaml"};
-```
-
-During bundling, the parsed YAML is inlined into the bundle as a JavaScript object.
-
-```ts
-var config = {
-  database: {
-    host: "localhost",
-    port: 5432,
-  },
-  // ...other fields
+  email: "johndoe@example.com",
 };
-config.database.host;
 ```
 
-If a `.yaml` or `.yml` file is passed as an entrypoint, it will be converted to a `.js` module that `export default`s the parsed object.
-
-{% codetabs %}
-
-```yaml#Input
-name: John Doe
-age: 35
-email: johndoe@example.com
-```
-
-```js#Output
-export default {
-  name: "John Doe",
-  age: 35,
-  email: "johndoe@example.com"
-}
-```
-
-{% /codetabs %}
-
-For more details on YAML support including the runtime API `Bun.YAML.parse()`, see the [YAML API documentation](/docs/api/yaml).
+</CodeGroup>
 
 ### `text`
 
@@ -195,17 +153,17 @@ console.log(contents);
 
 If a `.txt` file is passed as an entrypoint, it will be converted to a `.js` module that `export default`s the file contents.
 
-{% codetabs %}
+<CodeGroup>
 
-```txt#Input
+```txt Input
 Hello, world!
 ```
 
-```js#Output
+```ts Output
 export default "Hello, world!";
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 ### `napi`
 
@@ -224,7 +182,7 @@ In the bundler, `.node` files are handled using the [`file`](#file) loader.
 
 **SQLite loader**. `with { "type": "sqlite" }` import attribute
 
-In the runtime and bundler, SQLite databases can be directly imported. This will load the database using [`bun:sqlite`](https://bun.com/docs/api/sqlite).
+In the runtime and bundler, SQLite databases can be directly imported. This will load the database using [`bun:sqlite`](/runtime/sqlite).
 
 ```ts
 import db from "./my.db" with { type: "sqlite" };
@@ -241,7 +199,7 @@ You can change this behavior with the `"embed"` attribute:
 import db from "./my.db" with { type: "sqlite", embed: "true" };
 ```
 
-When using a [standalone executable](https://bun.com/docs/bundler/executables), the database is embedded into the single-file executable.
+When using a [standalone executable](/bundler/executables), the database is embedded into the single-file executable.
 
 Otherwise, the database to embed is copied into the `outdir` with a hashed filename.
 
@@ -256,37 +214,37 @@ The html loader processes HTML files and bundles any referenced assets. It will:
 
 For example, given this HTML file:
 
-{% codetabs %}
+<CodeGroup>
 
-```html#src/index.html
+```html src/index.html
 <!DOCTYPE html>
 <html>
   <body>
-    <img src="./image.jpg" alt="Local image">
-    <img src="https://example.com/image.jpg" alt="External image">
+    <img src="./image.jpg" alt="Local image" />
+    <img src="https://example.com/image.jpg" alt="External image" />
     <script type="module" src="./script.js"></script>
   </body>
 </html>
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 It will output a new HTML file with the bundled assets:
 
-{% codetabs %}
+<CodeGroup>
 
-```html#dist/output.html
+```html dist/output.html
 <!DOCTYPE html>
 <html>
   <body>
-    <img src="./image-HASHED.jpg" alt="Local image">
-    <img src="https://example.com/image.jpg" alt="External image">
+    <img src="./image-HASHED.jpg" alt="Local image" />
+    <img src="https://example.com/image.jpg" alt="External image" />
     <script type="module" src="./output-ALSO-HASHED.js"></script>
   </body>
 </html>
 ```
 
-{% /codetabs %}
+</CodeGroup>
 
 Under the hood, it uses [`lol-html`](https://github.com/cloudflare/lol-html) to extract script and link tags as entrypoints, and other assets as external.
 
@@ -311,7 +269,7 @@ Currently, the list of selectors is:
 - `video[poster]`
 - `video[src]`
 
-{% callout %}
+<Note>
 
 **HTML Loader Behavior in Different Contexts**
 
@@ -323,16 +281,16 @@ The `html` loader behaves differently depending on how it's used:
 
 3. **Full-stack Build:** When you run `bun build --target=bun server.ts` (where `server.ts` imports an HTML file), the import resolves to a manifest object that `Bun.serve` uses to efficiently serve pre-bundled assets in production.
 
-{% /callout %}
+</Note>
 
 ### `sh` loader
 
 **Bun Shell loader**. Default for `.sh` files
 
-This loader is used to parse [Bun Shell](https://bun.com/docs/runtime/shell) scripts. It's only supported when starting Bun itself, so it's not available in the bundler or in the runtime.
+This loader is used to parse [Bun Shell](/runtime/shell) scripts. It's only supported when starting Bun itself, so it's not available in the bundler or in the runtime.
 
 ```sh
-$ bun run ./script.sh
+bun run ./script.sh
 ```
 
 ### `file`
@@ -341,7 +299,7 @@ $ bun run ./script.sh
 
 The file loader resolves the import as a _path/URL_ to the imported file. It's commonly used for referencing media or font assets.
 
-```ts#logo.ts
+```ts logo.ts
 import logo from "./logo.svg";
 console.log(logo);
 ```
@@ -349,47 +307,32 @@ console.log(logo);
 _In the runtime_, Bun checks that the `logo.svg` file exists and converts it to an absolute path to the location of `logo.svg` on disk.
 
 ```bash
-$ bun run logo.ts
+bun run logo.ts
 /path/to/project/logo.svg
 ```
 
 _In the bundler_, things are slightly different. The file is copied into `outdir` as-is, and the import is resolved as a relative path pointing to the copied file.
 
-```ts#Output
+```ts Output
 var logo = "./logo.svg";
 console.log(logo);
 ```
 
 If a value is specified for `publicPath`, the import will use value as a prefix to construct an absolute path/URL.
 
-{% table %}
+| Public path                  | Resolved import                    |
+| ---------------------------- | ---------------------------------- |
+| `""` (default)               | `/logo.svg`                        |
+| `"/assets"`                  | `/assets/logo.svg`                 |
+| `"https://cdn.example.com/"` | `https://cdn.example.com/logo.svg` |
 
-- Public path
-- Resolved import
+<Note>
+  The location and file name of the copied file is determined by the value of [`naming.asset`](/bundler#naming).
+</Note>
+This loader is copied into the `outdir` as-is. The name of the copied file is determined using the value of
+`naming.asset`.
 
----
-
-- `""` (default)
-- `/logo.svg`
-
----
-
-- `"/assets"`
-- `/assets/logo.svg`
-
----
-
-- `"https://cdn.example.com/"`
-- `https://cdn.example.com/logo.svg`
-
-{% /table %}
-
-{% callout %}
-The location and file name of the copied file is determined by the value of [`naming.asset`](https://bun.com/docs/bundler#naming).
-{% /callout %}
-This loader is copied into the `outdir` as-is. The name of the copied file is determined using the value of `naming.asset`.
-
-{% details summary="Fixing TypeScript import errors" %}
+<Accordion title="Fixing TypeScript import errors">
 If you're using TypeScript, you may get an error like this:
 
 ```ts
@@ -407,4 +350,5 @@ declare module "*.svg" {
 ```
 
 This tells TypeScript that any default imports from `.svg` should be treated as a string.
-{% /details %}
+
+</Accordion>

package/docs/{api/glob.md → runtime/glob.mdx}

@@ -1,4 +1,7 @@
-Bun includes a fast native implementation of file globbing.
+---
+title: Glob
+description: Use Bun's fast native implementation of file globbing
+---
 
 ## Quickstart
 

package/docs/runtime/globals.mdx

@@ -0,0 +1,72 @@
+---
+title: Globals
+description: Use Bun's global objects
+---
+
+Bun implements the following globals.
+
+| Global                                                                                                                  | Source         | Notes                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)                                   | Web            |                                                                                                                                                                                                                                               |
+| [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`alert`](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert)                                                | Web            | Intended for command-line tools                                                                                                                                                                                                               |
+| [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)                                                         | Web            |                                                                                                                                                                                                                                               |
+| [`Buffer`](https://nodejs.org/api/buffer.html#class-buffer)                                                             | Node.js        | See [Node.js > `Buffer`](/runtime/nodejs-compat#node-buffer)                                                                                                                                                                                  |
+| `Bun`                                                                                                                   | Bun            | Subject to change as additional APIs are added                                                                                                                                                                                                |
+| [`ByteLengthQueuingStrategy`](https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy)               | Web            |                                                                                                                                                                                                                                               |
+| [`confirm`](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm)                                            | Web            | Intended for command-line tools                                                                                                                                                                                                               |
+| [`__dirname`](https://nodejs.org/api/globals.html#__dirname)                                                            | Node.js        |                                                                                                                                                                                                                                               |
+| [`__filename`](https://nodejs.org/api/globals.html#__filename)                                                          | Node.js        |                                                                                                                                                                                                                                               |
+| [`atob()`](https://developer.mozilla.org/en-US/docs/Web/API/atob)                                                       | Web            |                                                                                                                                                                                                                                               |
+| [`btoa()`](https://developer.mozilla.org/en-US/docs/Web/API/btoa)                                                       | Web            |                                                                                                                                                                                                                                               |
+| `BuildMessage`                                                                                                          | Bun            |                                                                                                                                                                                                                                               |
+| [`clearImmediate()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearImmediate)                            | Web            |                                                                                                                                                                                                                                               |
+| [`clearInterval()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearInterval)                              | Web            |                                                                                                                                                                                                                                               |
+| [`clearTimeout()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearTimeout)                                | Web            |                                                                                                                                                                                                                                               |
+| [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console)                                                   | Web            |                                                                                                                                                                                                                                               |
+| [`CountQueuingStrategy`](https://developer.mozilla.org/en-US/docs/Web/API/CountQueuingStrategy)                         | Web            |                                                                                                                                                                                                                                               |
+| [`Crypto`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto)                                                     | Web            |                                                                                                                                                                                                                                               |
+| [`crypto`](https://developer.mozilla.org/en-US/docs/Web/API/crypto)                                                     | Web            |                                                                                                                                                                                                                                               |
+| [`CryptoKey`](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey)                                               | Web            |                                                                                                                                                                                                                                               |
+| [`CustomEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`Event`](https://developer.mozilla.org/en-US/docs/Web/API/Event)                                                       | Web            | Also [`ErrorEvent`](https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent) [`CloseEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) [`MessageEvent`](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent). |
+| [`EventTarget`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`exports`](https://nodejs.org/api/globals.html#exports)                                                                | Node.js        |                                                                                                                                                                                                                                               |
+| [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)                                                       | Web            |                                                                                                                                                                                                                                               |
+| [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)                                                 | Web            |                                                                                                                                                                                                                                               |
+| [`global`](https://nodejs.org/api/globals.html#global)                                                                  | Node.js        | See [Node.js > `global`](/runtime/nodejs-compat#global).                                                                                                                                                                                      |
+| [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis)             | Cross-platform | Aliases to `global`                                                                                                                                                                                                                           |
+| [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers)                                                   | Web            |                                                                                                                                                                                                                                               |
+| [`HTMLRewriter`](/runtime/html-rewriter)                                                                                | Cloudflare     |                                                                                                                                                                                                                                               |
+| [`JSON`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON)                         | Web            |                                                                                                                                                                                                                                               |
+| [`MessageEvent`](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent)                                         | Web            |                                                                                                                                                                                                                                               |
+| [`module`](https://nodejs.org/api/globals.html#module)                                                                  | Node.js        |                                                                                                                                                                                                                                               |
+| [`performance`](https://developer.mozilla.org/en-US/docs/Web/API/performance)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`process`](https://nodejs.org/api/process.html)                                                                        | Node.js        | See [Node.js > `process`](/runtime/nodejs-compat#node-process)                                                                                                                                                                                |
+| [`prompt`](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt)                                              | Web            | Intended for command-line tools                                                                                                                                                                                                               |
+| [`queueMicrotask()`](https://developer.mozilla.org/en-US/docs/Web/API/queueMicrotask)                                   | Web            |                                                                                                                                                                                                                                               |
+| [`ReadableByteStreamController`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController)         | Web            |                                                                                                                                                                                                                                               |
+| [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)                                     | Web            |                                                                                                                                                                                                                                               |
+| [`ReadableStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultController)   | Web            |                                                                                                                                                                                                                                               |
+| [`ReadableStreamDefaultReader`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader)           | Web            |                                                                                                                                                                                                                                               |
+| [`reportError`](https://developer.mozilla.org/en-US/docs/Web/API/reportError)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`require()`](https://nodejs.org/api/globals.html#require)                                                              | Node.js        |                                                                                                                                                                                                                                               |
+| `ResolveMessage`                                                                                                        | Bun            |                                                                                                                                                                                                                                               |
+| [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)                                                 | Web            |                                                                                                                                                                                                                                               |
+| [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)                                                   | Web            |                                                                                                                                                                                                                                               |
+| [`setImmediate()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate)                                | Web            |                                                                                                                                                                                                                                               |
+| [`setInterval()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setInterval)                                  | Web            |                                                                                                                                                                                                                                               |
+| [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout)                                    | Web            |                                                                                                                                                                                                                                               |
+| [`ShadowRealm`](https://github.com/tc39/proposal-shadowrealm)                                                           | Web            | Stage 3 proposal                                                                                                                                                                                                                              |
+| [`SubtleCrypto`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto)                                         | Web            |                                                                                                                                                                                                                                               |
+| [`DOMException`](https://developer.mozilla.org/en-US/docs/Web/API/DOMException)                                         | Web            |                                                                                                                                                                                                                                               |
+| [`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`TextEncoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder)                                           | Web            |                                                                                                                                                                                                                                               |
+| [`TransformStream`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream)                                   | Web            |                                                                                                                                                                                                                                               |
+| [`TransformStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStreamDefaultController) | Web            |                                                                                                                                                                                                                                               |
+| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL)                                                           | Web            |                                                                                                                                                                                                                                               |
+| [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams)                                   | Web            |                                                                                                                                                                                                                                               |
+| [`WebAssembly`](https://nodejs.org/api/globals.html#webassembly)                                                        | Web            |                                                                                                                                                                                                                                               |
+| [`WritableStream`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream)                                     | Web            |                                                                                                                                                                                                                                               |
+| [`WritableStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController)   | Web            |                                                                                                                                                                                                                                               |
+| [`WritableStreamDefaultWriter`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter)           | Web            |                                                                                                                                                                                                                                               |

package/docs/{api/hashing.md → runtime/hashing.mdx}

@@ -1,8 +1,14 @@
-{% callout %}
+---
+title: Hashing
+description: Bun provides a set of utility functions for hashing and verifying passwords with various cryptographically secure algorithms
+---
 
-Bun implements the `createHash` and `createHmac` functions from [`node:crypto`](https://nodejs.org/api/crypto.html) in addition to the Bun-native APIs documented below.
+<Note>
+  Bun implements the `createHash` and `createHmac` functions from [`node:crypto`](https://nodejs.org/api/crypto.html) in
+  addition to the Bun-native APIs documented below.
+</Note>
 
-{% /callout %}
+---
 
 ## `Bun.password`
 
@@ -132,6 +138,8 @@ The format is composed of:
 - `salt`: `$xXnlSvPh4ym5KYmxKAuuHVlDvy2QGHBNuI6bJJrRDOs`
 - `hash`: `$2YY6M48XmHn+s5NoBaL+ficzXajq2Yj8wut3r0vnrwI`
 
+---
+
 ## `Bun.hash`
 
 `Bun.hash` is a collection of utilities for _non-cryptographic_ hashing. Non-cryptographic hashing algorithms are optimized for speed of computation over collision-resistance or security.
@@ -178,13 +186,14 @@ Bun.hash.murmur64v2("data", 1234);
 Bun.hash.rapidhash("data", 1234);
 ```
 
+---
+
 ## `Bun.CryptoHasher`
 
 `Bun.CryptoHasher` is a general-purpose utility class that lets you incrementally compute a hash of string or binary data using a range of cryptographic hash algorithms. The following algorithms are supported:
 
 - `"blake2b256"`
 - `"blake2b512"`
-- `"blake2s256"`
 - `"md4"`
 - `"md5"`
 - `"ripemd160"`
@@ -221,24 +230,11 @@ hasher.update(new ArrayBuffer(10));
 
 If a `string` is passed, an optional second parameter can be used to specify the encoding (default `'utf-8'`). The following encodings are supported:
 
-{% table %}
-
----
-
-- Binary encodings
-- `"base64"` `"base64url"` `"hex"` `"binary"`
-
----
-
-- Character encodings
-- `"utf8"` `"utf-8"` `"utf16le"` `"latin1"`
-
----
-
-- Legacy character encodings
-- `"ascii"` `"binary"` `"ucs2"` `"ucs-2"`
-
-{% /table %}
+| Category                   | Encodings                                   |
+| -------------------------- | ------------------------------------------- |
+| Binary encodings           | `"base64"` `"base64url"` `"hex"` `"binary"` |
+| Character encodings        | `"utf8"` `"utf-8"` `"utf16le"` `"latin1"`   |
+| Legacy character encodings | `"ascii"` `"binary"` `"ucs2"` `"ucs-2"`     |
 
 ```ts
 hasher.update("hello world"); // defaults to utf8

package/docs/{api/html-rewriter.md → runtime/html-rewriter.mdx}

@@ -1,5 +1,12 @@
+---
+title: HTMLRewriter
+description: Use Bun's HTMLRewriter to transform HTML documents with CSS selectors
+---
+
 HTMLRewriter lets you use CSS selectors to transform HTML documents. It works with `Request`, `Response`, as well as `string`. Bun's implementation is based on Cloudflare's [lol-html](https://github.com/cloudflare/lol-html).
 
+---
+
 ## Usage
 
 A common usecase is rewriting URLs in HTML content. Here's an example that rewrites image sources and link URLs to use a CDN domain:
@@ -9,16 +16,12 @@ A common usecase is rewriting URLs in HTML content. Here's an example that rewri
 const rewriter = new HTMLRewriter().on("img", {
   element(img) {
     // Famous rickroll video thumbnail
-    img.setAttribute(
-      "src",
-      "https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
-    );
+    img.setAttribute("src", "https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg");
 
     // Wrap the image in a link to the video
-    img.before(
-      '<a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">',
-      { html: true },
-    );
+    img.before('<a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">', {
+      html: true,
+    });
     img.after("</a>", { html: true });
 
     // Add some fun alt text
@@ -43,21 +46,29 @@ console.log(result);
 
 This replaces all images with a thumbnail of Rick Astley and wraps each `<img>` in a link, producing a diff like this:
 
-```html-diff
+```html
 <html>
   <body>
--    <img src="/cat.jpg">
--    <img src="dog.png">
--    <img src="https://example.com/bird.webp">
-+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
-+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll">
-+    </a>
-+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
-+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll">
-+    </a>
-+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
-+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll">
-+    </a>
+    <img src="/cat.jpg" /> // [!code --] <img src="dog.png" /> // [!code --]
+    <img src="https://example.com/bird.webp" /> // [!code --]
+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
+      // [!code ++]
+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll" />
+      // [!code ++]
+    </a>
+    // [!code ++]
+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
+      // [!code ++]
+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll" />
+      // [!code ++]
+    </a>
+    // [!code ++]
+    <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" target="_blank">
+      // [!code ++]
+      <img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="Definitely not a rickroll" />
+      // [!code ++]
+    </a>
+    // [!code ++]
   </body>
 </html>
 ```
@@ -180,10 +191,7 @@ rewriter.on("div", {
     el.setInnerContent(""); // Clear content
 
     // Position manipulation
-    el.before("Content before")
-      .after("Content after")
-      .prepend("First child")
-      .append("Last child");
+    el.before("Content before").after("Content after").prepend("First child").append("Last child");
 
     // HTML content insertion
     el.before("<span>before</span>", { html: true })
@@ -255,11 +263,7 @@ rewriter.on("*", {
     console.log(comment.removed); // Whether comment was removed
 
     // Manipulation
-    comment
-      .before("Before comment")
-      .after("After comment")
-      .replace("New comment")
-      .remove();
+    comment.before("Before comment").after("After comment").replace("New comment").remove();
 
     // HTML content insertion
     comment
@@ -329,6 +333,8 @@ try {
 }
 ```
 
+---
+
 ## See also
 
 You can also read the [Cloudflare documentation](https://developers.cloudflare.com/workers/runtime-apis/html-rewriter/), which this API is intended to be compatible with.