Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional args

args: string[]

Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

Optional defaultViewport

defaultViewport: null | { deviceScaleFactor?: number; hasTouch?: boolean; height?: number; isLandscape?: boolean; isMobile?: boolean; width?: number }

Sets a consistent viewport for each page. Defaults to an 800x600 viewport. null disables the default viewport.

Optional devtools

devtools: boolean

Whether to auto-open a DevTools panel for each tab. If this option is true, the headless option will be set false.

Optional dumpio

dumpio: boolean

Whether to pipe browser process stdout and stderr into process.stdout and process.stderr.

default

false

Optional env

env: {}

Specify environment variables that will be visible to Chromium.

default

process.env.

Type declaration

  • [key: string]: string | boolean | number

Optional executablePath

executablePath: string

Path to a Chromium executable to run instead of bundled Chromium. If executablePath is a relative path, then it is resolved relative to current working directory.

Optional handleSIGHUP

handleSIGHUP: boolean

Close chrome process on SIGHUP.

default

true

Optional handleSIGINT

handleSIGINT: boolean

Close chrome process on Ctrl-C.

default

true

Optional handleSIGTERM

handleSIGTERM: boolean

Close chrome process on SIGTERM.

default

true

Optional headless

headless: boolean

Whether to run browser in headless mode.

default

true unless the devtools option is true.

Optional ignoreDefaultArgs

ignoreDefaultArgs: boolean | string[]

Do not use puppeteer.defaultArgs() for launching Chromium.

default

false

Optional ignoreHTTPSErrors

ignoreHTTPSErrors: boolean

Whether to ignore HTTPS errors during navigation.

default

false

Optional pipe

pipe: boolean

Connects to the browser over a pipe instead of a WebSocket.

default

false

Optional product

product: (string & { _?: undefined }) | "chrome" | "firefox"

Which browser to launch. At this time, this is either chrome or firefox. See also PUPPETEER_PRODUCT.

default

'chrome'

Optional slowMo

slowMo: number

Slows down Puppeteer operations by the specified amount of milliseconds. Useful so that you can see what is going on.

Optional timeout

timeout: number

Maximum navigation time in milliseconds, pass 0 to disable timeout.

default

30000

Optional userDataDir

userDataDir: string

Path to a User Data Directory.

Generated using TypeDoc