Converters

​

UrlConverter

import { UrlConverter } from "chromiumly";

const converter = new UrlConverter();
const buffer = await converter.convert({
  url: string;  // required
  // + ConversionOptions (properties, header, footer, wait*, extraHttpHeaders, etc.)
});

​

HtmlConverter

import { HtmlConverter } from "chromiumly";

const converter = new HtmlConverter();
const buffer = await converter.convert({
  html: PathLikeOrReadStream;  // required (e.g. path to index.html)
  assets?: { file: PathLikeOrReadStream; name: string }[];
  header?: PathLikeOrReadStream;
  footer?: PathLikeOrReadStream;
  // + other ConversionOptions
});

​

MarkdownConverter

import { MarkdownConverter } from "chromiumly";

const converter = new MarkdownConverter();
const buffer = await converter.convert({
  html: PathLikeOrReadStream;   // required
  markdown: PathLikeOrReadStream | { file: PathLikeOrReadStream; name: string }[];  // required; array = multiple distinctly-named files
  assets?: { file: PathLikeOrReadStream; name: string }[];
  header?: PathLikeOrReadStream;
  footer?: PathLikeOrReadStream;
  // + other ConversionOptions
});

​

Shared conversion options

• properties — PageProperties (size, margins, landscape, singlePage, nativePageRanges, etc. — each independently optional)
• header, footer — path, Buffer, or ReadStream
• userAgent — override the User-Agent header sent by Chromium
• waitDelay, waitForSelector, waitForExpression
• extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, failOnResourceHttpStatusCodes, ignoreResourceHttpStatusDomains, failOnResourceLoadingFailed, skipNetworkIdleEvent, skipNetworkAlmostIdleEvent
• pdfUA, generateTaggedPdf (PDF/UA structure tags, independent of pdfUA), generateDocumentOutline
• pdfFormat — deprecated, no longer supported by Chromium since Gotenberg 8.0.0; use pdfa on PDFEngines.convert instead
• metadata, cookies, downloadFrom, webhook, outputFilename, trace
• split — ConvertSplit (mode, span, unify — no flatten, see Types)
• flatten — flatten the resulting PDF’s form fields and annotations
• userPassword, ownerPassword, and the six permission booleans (allowPrinting, allowCopying, allowModifying, allowAnnotating, allowFillingForms, allowAssembling)
• embeds, embedsMetadata — see Embedding files
• facturx — FacturXOptions, see Factur-X
• watermark, stamp — PdfEngineWatermark and PdfEngineStamp (PDF-engine post-processing)
• rotate — PdfEngineRotate (PDF-engine page rotation after conversion)