SDK reference overview

Chromiumly is a TypeScript library that runs on Node.js, Deno, and Bun. It does not expose a REST API; you use the SDK in your application to call Gotenberg (or the hosted API).

Main exports

From the default entry point (chromiumly):

Export	Description
`Chromiumly`	Config class: `configure()`, endpoint/API key resolution
`System`	System routes: health checks, version, debug, and metrics
`UrlConverter`	Convert URL → PDF
`HtmlConverter`	Convert HTML file → PDF
`MarkdownConverter`	Convert HTML + Markdown → PDF
`UrlScreenshot`	Capture URL → image (PNG/JPEG/WebP)
`HtmlScreenshot`	Capture HTML file → image
`MarkdownScreenshot`	Capture HTML + Markdown → image
`LibreOffice`	Convert office documents → PDF (static `convert()`)
`PDFEngines`	Merge, split, rotate, flatten, convert to PDF/A, read/write metadata, read/write bookmarks, encrypt, embed, Factur-X (`facturX`), `generate()`
`Templates`	Hosted template generation (`generate()`) for invoice PDFs
`PdfFormat`	Enum: `PdfFormat.A_1b`, `A_2b`, `A_3b` (PDF/A); `A_1a` also exists, deprecated for backward compatibility

Usage pattern

import { Chromiumly, UrlConverter, PDFEngines, PdfFormat } from "chromiumly";

// Configure once (or use env)
Chromiumly.configure({ apiKey: "..." }); // or { endpoint: "http://localhost:3000" }

// Convert
const urlConverter = new UrlConverter();
const buffer = await urlConverter.convert({ url: "https://example.com/" });

// Optional: write to __generated__/out.pdf
await PDFEngines.generate("out.pdf", buffer);

Reference pages

Chromiumly — configure() and config options
System — health, version, debug, and metrics routes
Converters — UrlConverter, HtmlConverter, MarkdownConverter
Screenshots — UrlScreenshot, HtmlScreenshot, MarkdownScreenshot
LibreOffice — LibreOffice.convert()
PDFEngines — merge, split, rotate, flatten, convert, metadata, bookmarks, encrypt, embed, facturX, generate
Types — PageProperties, ConversionOptions, ImageProperties, PdfFormat, Split, PdfEngineRotate, etc.
Templates guide — hosted Templates.generate() and request shape

​Main exports

​Usage pattern

​Reference pages

Main exports

Usage pattern

Reference pages