Type alias Options

Type declaration

• format: "png" | "jpeg"

  Image format

• Optional outDir?: string

  Directory relative to current working directory to output images.

• Optional quality?: number

  If format is jpeg, the quality of the image, 0 - 100.

• Optional crawl?: boolean

  Crawl links on the page at url and look for more pappable shots.

• Optional awaitElement?: string

  CSS selector of an element to await on the page before taking a screenshot.

• Optional timeout?: number

  A number of milliseconds to wait for the page to settle before taking the screenshot.

• Optional viewport?: {
      width: number;
      height: number;
  }

  Viewport dimensions for Playwright browser emulator

  • width: number

    Viewport width in pixels

  • height: number

    Viewport height in pixels