Copy

Html2RealPdf

Reusable renderer backed by one Worker or main-thread WASM context.

ON_THIS_PAGE
  1. Signature
  2. Methods
  3. render()
  4. Parameters
  5. Returns
  6. Errors
  7. dispose()
  8. Parameters
  9. Returns

Reusable renderer backed by one Worker or main-thread WASM context.

Create instances with createRenderer. Fonts and execution mode belong to the renderer lifetime; each returned PdfDocument has its own shorter lifetime. Call dispose when the renderer is no longer needed.

Signature

export declare class Html2RealPdf
SOURCE:142

Methods

render()

Snapshots browser state and renders one PDF.

render(source: HtmlSource, options?: RenderOptions): Promise<PdfDocument>;

Parameters

ParameterTypeRequiredDefaultDescription
sourceHtmlSourceYesNoneHTML string, mounted element, or ref-shaped value to render.
optionsRenderOptionsNo{}Options for this operation.

Returns

Promise<PdfDocument>

Errors

  • InvalidSourceError when a ref is null or the source shape is invalid.
  • UnsupportedCssError when strict CSS or fallback policy rejects input.
  • ResourceLoadError when required resources cannot be materialized.
SOURCE:159

dispose()

Terminates the owned backend and rejects future renders.

dispose(): void;

Parameters

This API does not accept parameters.

Returns

void
SOURCE:205
ON_THIS_PAGE
  1. Signature
  2. Methods
  3. render()
  4. Parameters
  5. Returns
  6. Errors
  7. dispose()
  8. Parameters
  9. Returns
html2realpdf documentationCopyright © Imggion
DOCUMENTATION_TREE