Skip to main content
All three classes are instantiated with new and expose a single async method: convert(options) → Promise<Buffer>.

​
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;  // required
  header?: PathLikeOrReadStream;
  footer?: PathLikeOrReadStream;
  // + other ConversionOptions
});

​
Shared conversion options

See Types for full definitions. Summary:
  • properties — PageProperties (size, margins, landscape, singlePage, etc.)
  • header, footer — path, Buffer, or ReadStream
  • waitDelay, waitForSelector, waitForExpression
  • extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, failOnResourceHttpStatusCodes, ignoreResourceHttpStatusDomains, failOnResourceLoadingFailed, skipNetworkIdleEvent
  • pdfUA, metadata, cookies, downloadFrom
  • split — Split (mode, span, unify, flatten)
  • userPassword, ownerPassword, embeds
PathLikeOrReadStream = string (path) | Buffer | ReadStream.