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

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

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

Files changed (308) hide show

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

package/docs/api/html-rewriter.md DELETED Viewed

@@ -1,334 +0,0 @@
-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:
-```ts
-// Replace all images with a rickroll
-const rewriter = new HTMLRewriter().on("img", {
-  element(img) {
-    // Famous rickroll video thumbnail
-    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.after("</a>", { html: true });
-    // Add some fun alt text
-    img.setAttribute("alt", "Definitely not a rickroll");
-  },
-});
-// An example HTML document
-const html = `
-<html>
-<body>
-  <img src="/cat.jpg">
-  <img src="dog.png">
-  <img src="https://example.com/bird.webp">
-</body>
-</html>
-`;
-const result = rewriter.transform(html);
-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>
-  <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>
-  </body>
-</html>
-```
-Now every image on the page will be replaced with a thumbnail of Rick Astley, and clicking any image will lead to [a very famous video](https://www.youtube.com/watch?v=dQw4w9WgXcQ).
-### Input types
-HTMLRewriter can transform HTML from various sources. The input is automatically handled based on its type:
-```ts
-// From Response
-rewriter.transform(new Response("<div>content</div>"));
-// From string
-rewriter.transform("<div>content</div>");
-// From ArrayBuffer
-rewriter.transform(new TextEncoder().encode("<div>content</div>").buffer);
-// From Blob
-rewriter.transform(new Blob(["<div>content</div>"]));
-// From File
-rewriter.transform(Bun.file("index.html"));
-```
-Note that Cloudflare Workers implementation of HTMLRewriter only supports `Response` objects.
-### Element Handlers
-The `on(selector, handlers)` method allows you to register handlers for HTML elements that match a CSS selector. The handlers are called for each matching element during parsing:
-```ts
-rewriter.on("div.content", {
-  // Handle elements
-  element(element) {
-    element.setAttribute("class", "new-content");
-    element.append("<p>New content</p>", { html: true });
-  },
-  // Handle text nodes
-  text(text) {
-    text.replace("new text");
-  },
-  // Handle comments
-  comments(comment) {
-    comment.remove();
-  },
-});
-```
-The handlers can be asynchronous and return a Promise. Note that async operations will block the transformation until they complete:
-```ts
-rewriter.on("div", {
-  async element(element) {
-    await Bun.sleep(1000);
-    element.setInnerContent("<span>replace</span>", { html: true });
-  },
-});
-```
-### CSS Selector Support
-The `on()` method supports a wide range of CSS selectors:
-```ts
-// Tag selectors
-rewriter.on("p", handler);
-// Class selectors
-rewriter.on("p.red", handler);
-// ID selectors
-rewriter.on("h1#header", handler);
-// Attribute selectors
-rewriter.on("p[data-test]", handler); // Has attribute
-rewriter.on('p[data-test="one"]', handler); // Exact match
-rewriter.on('p[data-test="one" i]', handler); // Case-insensitive
-rewriter.on('p[data-test="one" s]', handler); // Case-sensitive
-rewriter.on('p[data-test~="two"]', handler); // Word match
-rewriter.on('p[data-test^="a"]', handler); // Starts with
-rewriter.on('p[data-test$="1"]', handler); // Ends with
-rewriter.on('p[data-test*="b"]', handler); // Contains
-rewriter.on('p[data-test|="a"]', handler); // Dash-separated
-// Combinators
-rewriter.on("div span", handler); // Descendant
-rewriter.on("div > span", handler); // Direct child
-// Pseudo-classes
-rewriter.on("p:nth-child(2)", handler);
-rewriter.on("p:first-child", handler);
-rewriter.on("p:nth-of-type(2)", handler);
-rewriter.on("p:first-of-type", handler);
-rewriter.on("p:not(:first-child)", handler);
-// Universal selector
-rewriter.on("*", handler);
-```
-### Element Operations
-Elements provide various methods for manipulation. All modification methods return the element instance for chaining:
-```ts
-rewriter.on("div", {
-  element(el) {
-    // Attributes
-    el.setAttribute("class", "new-class").setAttribute("data-id", "123");
-    const classAttr = el.getAttribute("class"); // "new-class"
-    const hasId = el.hasAttribute("id"); // boolean
-    el.removeAttribute("class");
-    // Content manipulation
-    el.setInnerContent("New content"); // Escapes HTML by default
-    el.setInnerContent("<p>HTML content</p>", { html: true }); // Parses HTML
-    el.setInnerContent(""); // Clear content
-    // Position manipulation
-    el.before("Content before")
-      .after("Content after")
-      .prepend("First child")
-      .append("Last child");
-    // HTML content insertion
-    el.before("<span>before</span>", { html: true })
-      .after("<span>after</span>", { html: true })
-      .prepend("<span>first</span>", { html: true })
-      .append("<span>last</span>", { html: true });
-    // Removal
-    el.remove(); // Remove element and contents
-    el.removeAndKeepContent(); // Remove only the element tags
-    // Properties
-    console.log(el.tagName); // Lowercase tag name
-    console.log(el.namespaceURI); // Element's namespace URI
-    console.log(el.selfClosing); // Whether element is self-closing (e.g. <div />)
-    console.log(el.canHaveContent); // Whether element can contain content (false for void elements like <br>)
-    console.log(el.removed); // Whether element was removed
-    // Attributes iteration
-    for (const [name, value] of el.attributes) {
-      console.log(name, value);
-    }
-    // End tag handling
-    el.onEndTag(endTag => {
-      endTag.before("Before end tag");
-      endTag.after("After end tag");
-      endTag.remove(); // Remove the end tag
-      console.log(endTag.name); // Tag name in lowercase
-    });
-  },
-});
-```
-### Text Operations
-Text handlers provide methods for text manipulation. Text chunks represent portions of text content and provide information about their position in the text node:
-```ts
-rewriter.on("p", {
-  text(text) {
-    // Content
-    console.log(text.text); // Text content
-    console.log(text.lastInTextNode); // Whether this is the last chunk
-    console.log(text.removed); // Whether text was removed
-    // Manipulation
-    text.before("Before text").after("After text").replace("New text").remove();
-    // HTML content insertion
-    text
-      .before("<span>before</span>", { html: true })
-      .after("<span>after</span>", { html: true })
-      .replace("<span>replace</span>", { html: true });
-  },
-});
-```
-### Comment Operations
-Comment handlers allow comment manipulation with similar methods to text nodes:
-```ts
-rewriter.on("*", {
-  comments(comment) {
-    // Content
-    console.log(comment.text); // Comment text
-    comment.text = "New comment text"; // Set comment text
-    console.log(comment.removed); // Whether comment was removed
-    // Manipulation
-    comment
-      .before("Before comment")
-      .after("After comment")
-      .replace("New comment")
-      .remove();
-    // HTML content insertion
-    comment
-      .before("<span>before</span>", { html: true })
-      .after("<span>after</span>", { html: true })
-      .replace("<span>replace</span>", { html: true });
-  },
-});
-```
-### Document Handlers
-The `onDocument(handlers)` method allows you to handle document-level events. These handlers are called for events that occur at the document level rather than within specific elements:
-```ts
-rewriter.onDocument({
-  // Handle doctype
-  doctype(doctype) {
-    console.log(doctype.name); // "html"
-    console.log(doctype.publicId); // public identifier if present
-    console.log(doctype.systemId); // system identifier if present
-  },
-  // Handle text nodes
-  text(text) {
-    console.log(text.text);
-  },
-  // Handle comments
-  comments(comment) {
-    console.log(comment.text);
-  },
-  // Handle document end
-  end(end) {
-    end.append("<!-- Footer -->", { html: true });
-  },
-});
-```
-### Response Handling
-When transforming a Response:
-- The status code, headers, and other response properties are preserved
-- The body is transformed while maintaining streaming capabilities
-- Content-encoding (like gzip) is handled automatically
-- The original response body is marked as used after transformation
-- Headers are cloned to the new response
-## Error Handling
-HTMLRewriter operations can throw errors in several cases:
-- Invalid selector syntax in `on()` method
-- Invalid HTML content in transformation methods
-- Stream errors when processing Response bodies
-- Memory allocation failures
-- Invalid input types (e.g., passing Symbol)
-- Body already used errors
-Errors should be caught and handled appropriately:
-```ts
-try {
-  const result = rewriter.transform(input);
-  // Process result
-} catch (error) {
-  console.error("HTMLRewriter error:", error);
-}
-```
-## 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.