Skip to main content
Page other methods for the Puppeteer driver.

​
setViewport

Set the viewport size. Pass null to reset to default. Upstream docs
​
viewport
PuppeteerViewport | null
required
await page.setViewport(/* PuppeteerViewport | null */);

​
emulateMediaType

Emulate media type. Upstream docs
​
type
'screen' | 'print' | null
await page.emulateMediaType();

​
emulateMediaFeatures

Emulate media features. Upstream docs
​
features
Array<{ name: string; value: string }>
await page.emulateMediaFeatures();

​
emulateTimezone

Emulate timezone. Upstream docs
​
timezoneId
string
await page.emulateTimezone();

​
emulateVisionDeficiency

Emulate vision deficiency. Upstream docs
​
type
'none' | 'achromatopsia' | 'deuteranopia' | 'protanopia' | 'tritanopia' | 'blurredVision'
await page.emulateVisionDeficiency();

​
setGeolocation

Set geolocation. Upstream docs
​
geolocation
PuppeteerGeolocation
required
await page.setGeolocation(/* PuppeteerGeolocation */);

​
setUserAgent

Set user agent. Upstream docs
​
userAgent
string
required
await page.setUserAgent('...');

​
setExtraHTTPHeaders

Set extra HTTP headers. Upstream docs
​
headers
Record<string, string>
required
await page.setExtraHTTPHeaders(/* Record<string, string> */);

​
createCDPSession

Create a CDP session.
Note: Returns a session identifier in RPC mode (not a live CDPSession).
Upstream docs
​
result
{ sessionId: string }
Return value
await page.createCDPSession();

​
sendCDP

Send a CDP command directly.
​
method
string
required
​
params
Record<string, unknown>
​
result
unknown
Return value
await page.sendCDP('...');

​
metrics

Get metrics. Upstream docs
​
result
Record<string, number>
Return value
await page.metrics();

​
setJavaScriptEnabled

Set JavaScript enabled/disabled. Upstream docs
​
enabled
boolean
required
await page.setJavaScriptEnabled(true);

​
setCacheEnabled

Set cache enabled/disabled. Upstream docs
​
enabled
boolean
required
await page.setCacheEnabled(true);

​
setOfflineMode

Set offline mode. Upstream docs
​
enabled
boolean
required
await page.setOfflineMode(true);

​
emulateNetworkConditions

Emulate network conditions. Upstream docs
​
conditions
{ offline: boolean; downloadThroughput: number; uploadThroughput: number; latency: number } | null
required
await page.emulateNetworkConditions(/* { offline: boolean; downloadThroughput: number; uploadThroughput: number; latency: number } | null */);

​
addScriptTag

Add script tag. Upstream docs
​
options
{ url?: string; path?: string; content?: string; type?: string }
required
​
result
PuppeteerSerializedElement
Return value
await page.addScriptTag(/* { url?: string; path?: string; content?: string; type?: string } */);

​
addStyleTag

Add style tag. Upstream docs
​
options
{ url?: string; path?: string; content?: string }
required
​
result
PuppeteerSerializedElement
Return value
await page.addStyleTag(/* { url?: string; path?: string; content?: string } */);

​
setRequestInterception

Set request interception enabled/disabled. Upstream docs
​
enabled
boolean
required
await page.setRequestInterception(true);

​
authenticate

Authenticate with HTTP auth. Upstream docs
​
credentials
{ username: string; password: string } | null
required
await page.authenticate(/* { username: string; password: string } | null */);

​
mainFrame

Get the main frame. Upstream docs
​
result
RemotePuppeteerFrame
Return value
await page.mainFrame();

​
frames

Get all frames. Upstream docs
​
result
RemotePuppeteerFrame[]
Return value
await page.frames();

​
setDefaultNavigationTimeout

Set the default navigation timeout. Upstream docs
​
timeout
number
required
await page.setDefaultNavigationTimeout(0);

​
setDefaultTimeout

Set the default timeout. Upstream docs
​
timeout
number
required
await page.setDefaultTimeout(0);

​
getDefaultNavigationTimeout

Get the default navigation timeout.
​
result
number
Return value
await page.getDefaultNavigationTimeout();

​
getDefaultTimeout

Get the default timeout.
​
result
number
Return value
await page.getDefaultTimeout();

​
setBypassCSP

Toggle bypassing Content-Security-Policy. Upstream docs
​
enabled
boolean
required
await page.setBypassCSP(true);

​
removeScriptToEvaluateOnNewDocument

Remove an injected script. Upstream docs
​
identifier
string
required
await page.removeScriptToEvaluateOnNewDocument('...');

​
removeExposedFunction

Remove an exposed function. Upstream docs
​
name
string
required
await page.removeExposedFunction('...');

​
emulate

Emulate a device (viewport + user agent). Upstream docs
​
device
PuppeteerDevice
required
await page.emulate(/* PuppeteerDevice */);

​
emulateCPUThrottling

Emulate CPU throttling. Upstream docs
​
factor
number | null
required
await page.emulateCPUThrottling(/* number | null */);

​
emulateIdleState

Emulate idle state. Upstream docs
​
overrides
PuppeteerIdleOverrides
await page.emulateIdleState();

​
setBypassServiceWorker

Set service worker bypass. Upstream docs
​
bypass
boolean
required
await page.setBypassServiceWorker(true);

​
setDragInterception

Set drag interception. Upstream docs
​
enabled
boolean
required
await page.setDragInterception(true);

​
target

Get the target for this page. Upstream docs
​
result
PuppeteerTarget
Return value
await page.target();

​
workers

Get all web workers for this page. Upstream docs
​
result
PuppeteerWebWorker[]
Return value
await page.workers();

​
windowId

Get the window ID.
​
result
number
Return value
await page.windowId();

​
resize

Resize the page.
​
options
{ width: number; height: number }
required
await page.resize(/* { width: number; height: number } */);

​
queryObjects

Query all objects of a given prototype. Upstream docs
​
prototypeHandle
RemotePuppeteerElementHandle
required
​
result
RemotePuppeteerElementHandle
Return value
await page.queryObjects(/* RemotePuppeteerElementHandle */);

​
openDevTools

Open DevTools. Only works in headful mode. Upstream docs
​
options
{ docking?: 'right' | 'bottom' | 'left' | 'undocked' }
await page.openDevTools();