API Reference

The TypeScript package root is the only public entry point.

import html2pdf, {
  createRenderer,
  renderPdf,
  type RenderOptions,
} from "@imggion/html2realpdf";

The generated reference follows bindings/js/src/index.ts and the package export map. It excludes raw Worker, snapshot, page normalization, and WebAssembly bridge modules that are not exported to package users.

Source links point to the exact submodule commit used to generate this reference. That source can include APIs added after the published npm release; check PDF/A-3 source availability before using the archival and attachment options.

Primary functions#

• renderPdf renders through the package default Worker renderer.
• createRenderer creates an owned renderer.
• html2pdf creates the compatibility chain.

Result handles#

• PdfDocument owns PDF bytes, object URLs, and previews.
• PdfPreview controls the in-page canvas viewer.
• Html2RealPdf is the reusable renderer returned by createRenderer.

Configuration#

• RenderOptions controls one render.
• RendererInit controls renderer lifetime resources.
• PageOptions defines explicit page geometry.
• PdfPreviewOptions configures the in-page viewer.
• Html2PdfOptions contains the supported compatibility subset.
• PdfAttachment describes a file embedded in one render.

Errors#

All public wrapper errors extend Html2RealPdfError. Its code value is stable for control flow and telemetry.

Open the generated API index for every function, interface, type alias, and class.