Skip to main content
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):
ExportDescription
ChromiumlyConfig class: configure(), endpoint/API key resolution
SystemSystem routes: health checks, version, debug, and metrics
UrlConverterConvert URL → PDF
HtmlConverterConvert HTML file → PDF
MarkdownConverterConvert HTML + Markdown → PDF
UrlScreenshotCapture URL → image (PNG/JPEG/WebP)
HtmlScreenshotCapture HTML file → image
MarkdownScreenshotCapture HTML + Markdown → image
LibreOfficeConvert office documents → PDF (static convert())
PDFEnginesMerge, split, rotate, flatten, convert to PDF/A, read/write metadata, read/write bookmarks, encrypt, embed, generate()
TemplatesHosted template generation (generate()) for invoice PDFs
PdfFormatEnum: PdfFormat.A_1a, A_2b, A_3b (PDF/A)

​
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, generate
  • Types — PageProperties, ConversionOptions, ImageProperties, PdfFormat, Split, PdfEngineRotate, etc.
  • Templates guide — hosted Templates.generate() and request shape