prerendercloud.d.ts

export = prerendercloud;

declare function prerendercloud(...args: any[]): void;

declare namespace prerendercloud {
  class Options {
    constructor(...args: any[]);

    isThrottled(...args: any[]): void;

    recordFail(...args: any[]): void;

    reset(...args: any[]): void;

    set(...args: any[]): void;

    static validOptions: string[];
  }

  const botsOnlyList: string[];

  const cache: any;

  function pdf(url: string, options?: PdfOptions): Promise<Buffer>;

  function prerender(url: string, params?: any): Promise<Buffer>;

  function resetOptions(): any;

  function scrape(url: string, options?: ScrapeOptions): Promise<ScrapeResult>;

  function screenshot(
    url: string,
    options?: ScreenshotOptions
  ): Promise<Buffer>;

  function set(optionKey: string, optionValue: any): any;

  function userAgentIsBot(
    headers: { [key: string]: string },
    requestedPath?: string
  ): boolean;

  namespace util {
    function basenameIsHtml(basename: string): boolean;

    function isFunction(functionToCheck: any): boolean;

    function urlPathIsHtml(urlPath: string): boolean;
  }

  interface PdfOptions {
    noPageBreaks?: boolean;
    pageRanges?: string;
    scale?: number;
    preferCssPageSize?: boolean;
    printBackground?: boolean;
    landscape?: boolean;
    marginTop?: number;
    marginRight?: number;
    marginBottom?: number;
    marginLeft?: number;
    paperWidth?: number;
    paperHeight?: number;
    emulatedMedia?:
      | "screen"
      | "print"
      | "braille"
      | "embossed"
      | "handheld"
      | "projection"
      | "speech"
      | "tty"
      | "tv";
    waitExtraLong?: boolean;
    dontWaitForWebSockets?: boolean;
    blockCookies?: boolean;
  }

  interface ScreenshotOptions {
    deviceWidth?: number; // Default: 1366
    deviceHeight?: number; // Default: 768
    deviceIsMobile?: boolean; // Default: false
    viewportQuerySelector?: string;
    viewportQuerySelectorPadding?: number;
    viewportWidth?: number; // Defaults to deviceWidth
    viewportHeight?: number; // Defaults to deviceHeight
    viewportX?: number; // Default: 0
    viewportY?: number; // Default: 0
    viewportScale?: number; // Default: 1, min: 0.1, max: 3.0
    format?: "png" | "webp" | "jpeg"; // Default: png
    emulatedMedia?:
      | "screen"
      | "print"
      | "braille"
      | "embossed"
      | "handheld"
      | "projection"
      | "speech"
      | "tty"
      | "tv"; // Default: screen
    waitExtraLong?: boolean;
    dontWaitForWebSockets?: boolean;
    blockCookies?: boolean;
  }

  interface ScrapeOptions {
    withMetadata?: boolean;
    withScreenshot?: boolean;
    followRedirects?: boolean; // Default: false
    deviceIsMobile?: boolean; // Default: false
    deviceWidth?: number; // Default: 1366, min: 10, max: 10000
    deviceHeight?: number; // Default: 768, min: 10, max: 10000
    emulatedMedia?:
      | "screen"
      | "print"
      | "braille"
      | "embossed"
      | "handheld"
      | "projection"
      | "speech"
      | "tty"
      | "tv"; // Default: screen
    waitExtraLong?: boolean;
    dontWaitForWebSockets?: boolean;
    blockCookies?: boolean;
  }

  interface ScrapeResult {
    body: string;
    meta: {
      title: string;
      h1: string;
      description: string;
      ogImage: string;
      ogTitle: string;
      ogDescription: string;
      ogType: string;
      twitterCard: string;
    };
    links: string[];
    screenshot: Buffer;
    statusCode: number;
    headers: { [key: string]: string };
  }
}