***

title: Puppeteer Page
description: Complete Page method reference for the Puppeteer driver.
---------------------------------------------------------------------

All `Page` methods available when using the **Puppeteer** driver.

Access via `runtime.page` after launching a Puppeteer runtime.

<Accordion title="How these methods work over HTTP">
  Every method below is a remote call. The SDK translates it into a structured step sent to a single endpoint:

  ```
  POST /v1/workspaces/{workspaceId}/execute
  ```

  ```json
  {
    "runtime": "my-browser",
    "steps": [
      {
        "call": "page.goto",
        "args": ["https://example.com"]
      }
    ]
  }
  ```

  The `call` field maps directly to the method name. `args` is a JSON array of the method's arguments. You can batch multiple steps in one request.
</Accordion>

## Navigation

### goto(url, options?)

Navigate to a URL.

```ts
await runtime.page.goto('...');
```

| Parameter | Type                   | Required | Description |
| --------- | ---------------------- | -------- | ----------- |
| `url`     | `string`               | Yes      | —           |
| `options` | `PuppeteerGotoOptions` | No       | —           |

**Returns** `PuppeteerHTTPResponse \| null`
— The main resource response, or null if navigating to about:blank.

[Upstream docs](https://pptr.dev/api/puppeteer.page.goto)

***

### reload(options?)

Reload the page.

```ts
await runtime.page.reload();
```

| Parameter | Type                     | Required | Description |
| --------- | ------------------------ | -------- | ----------- |
| `options` | `PuppeteerReloadOptions` | No       | —           |

**Returns** `PuppeteerHTTPResponse \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.reload)

***

### goBack(options?)

Navigate back in history.

```ts
await runtime.page.goBack();
```

| Parameter | Type                                | Required | Description |
| --------- | ----------------------------------- | -------- | ----------- |
| `options` | `PuppeteerWaitForNavigationOptions` | No       | —           |

**Returns** `PuppeteerHTTPResponse \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.goback)

***

### goForward(options?)

Navigate forward in history.

```ts
await runtime.page.goForward();
```

| Parameter | Type                                | Required | Description |
| --------- | ----------------------------------- | -------- | ----------- |
| `options` | `PuppeteerWaitForNavigationOptions` | No       | —           |

**Returns** `PuppeteerHTTPResponse \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.goforward)

***

### waitForNavigation(options?)

Wait for navigation to complete.

```ts
await runtime.page.waitForNavigation();
```

| Parameter | Type                                | Required | Description |
| --------- | ----------------------------------- | -------- | ----------- |
| `options` | `PuppeteerWaitForNavigationOptions` | No       | —           |

**Returns** `PuppeteerHTTPResponse \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitfornavigation)

***

## Page Info

### title()

Get the page title.

```ts
await runtime.page.title();
```

**Returns** `string`

[Upstream docs](https://pptr.dev/api/puppeteer.page.title)

***

### url()

Get the current URL.

```ts
await runtime.page.url();
```

**Returns** `string`

[Upstream docs](https://pptr.dev/api/puppeteer.page.url)

***

### content()

Get the full HTML content.

```ts
await runtime.page.content();
```

**Returns** `string`

[Upstream docs](https://pptr.dev/api/puppeteer.page.content)

***

### setContent(html, options?)

Set the page content.

```ts
await runtime.page.setContent('...');
```

| Parameter | Type                                       | Required | Description |
| --------- | ------------------------------------------ | -------- | ----------- |
| `html`    | `string`                                   | Yes      | —           |
| `options` | `{ timeout?: number; waitUntil?: string }` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setcontent)

***

### setViewport(viewport)

Set the viewport size. Pass null to reset to default.

```ts
await runtime.page.setViewport(/* viewport */);
```

| Parameter  | Type                        | Required | Description |
| ---------- | --------------------------- | -------- | ----------- |
| `viewport` | `PuppeteerViewport \| null` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setviewport)

***

### viewport()

Get the current viewport.

```ts
await runtime.page.viewport();
```

**Returns** `PuppeteerViewport \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.viewport)

***

## Actions

### click(selector, options?)

Click on an element matching the selector.

```ts
await runtime.page.click('...');
```

| Parameter  | Type                    | Required | Description |
| ---------- | ----------------------- | -------- | ----------- |
| `selector` | `string`                | Yes      | —           |
| `options`  | `PuppeteerClickOptions` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.click)

***

### type(selector, text, options?)

Type text into an element.

```ts
await runtime.page.type('...', '...');
```

| Parameter  | Type                           | Required | Description |
| ---------- | ------------------------------ | -------- | ----------- |
| `selector` | `string`                       | Yes      | —           |
| `text`     | `string`                       | Yes      | —           |
| `options`  | `PuppeteerKeyboardTypeOptions` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.type)

***

### focus(selector)

Focus on an element.

```ts
await runtime.page.focus('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.focus)

***

### hover(selector)

Hover over an element.

```ts
await runtime.page.hover('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.hover)

***

### select(selector, ...values)

Select options in a \<select> element.

```ts
await runtime.page.select('...', /* values */);
```

| Parameter  | Type                                 | Required | Description |
| ---------- | ------------------------------------ | -------- | ----------- |
| `selector` | `string`                             | Yes      | —           |
| `values`   | `(string \| PuppeteerSelectValue)[]` | Yes      | —           |

**Returns** `string[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page.select)

***

### tap(selector)

Tap on an element (for touch devices).

```ts
await runtime.page.tap('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.tap)

***

## Queries

### \$(selector)

Query for a single element.

```ts
await runtime.page.$('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

**Returns** `RemotePuppeteerElementHandle \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page._)

***

### \$\$(selector)

Query for all matching elements.

```ts
await runtime.page.$$('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

**Returns** `RemotePuppeteerElementHandle[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page.__)

***

### \$x(expression)

Evaluate XPath expression.

```ts
await runtime.page.$x('...');
```

| Parameter    | Type     | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `expression` | `string` | Yes      | —           |

**Returns** `RemotePuppeteerElementHandle[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page._x)

***

### locator(selector)

Create a locator for the given selector.

```ts
runtime.page.locator('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

**Returns** `RemotePuppeteerLocator`

[Upstream docs](https://pptr.dev/api/puppeteer.page.locator)

***

## Content

### textContent(selector)

Get the text content of an element matching the selector.

```ts
await runtime.page.textContent('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

**Returns** `string \| null`

***

### innerHTML(selector)

Get the inner HTML of an element matching the selector.

```ts
await runtime.page.innerHTML('...');
```

| Parameter  | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `selector` | `string` | Yes      | —           |

**Returns** `string`

***

## State Checks

### isJavaScriptEnabled()

Check if JavaScript is enabled.

```ts
await runtime.page.isJavaScriptEnabled();
```

**Returns** `boolean`

[Upstream docs](https://pptr.dev/api/puppeteer.page.isjavascriptenabled)

***

### isDragInterceptionEnabled()

Check if drag interception is enabled.

```ts
runtime.page.isDragInterceptionEnabled();
```

**Returns** `boolean`

[Upstream docs](https://pptr.dev/api/puppeteer.page.isdraginterceptionenabled)

***

### isServiceWorkerBypassed()

Check if service worker bypass is enabled.

```ts
await runtime.page.isServiceWorkerBypassed();
```

**Returns** `boolean`

[Upstream docs](https://pptr.dev/api/puppeteer.page.isserviceworkerbypassed)

***

## Waiting

### waitForSelector(selector, options?)

Wait for a selector to appear in the DOM.

```ts
await runtime.page.waitForSelector('...');
```

| Parameter  | Type                      | Required | Description |
| ---------- | ------------------------- | -------- | ----------- |
| `selector` | `string`                  | Yes      | —           |
| `options`  | `PuppeteerWaitForOptions` | No       | —           |

**Returns** `RemotePuppeteerElementHandle \| null`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforselector)

***

### waitForTimeout(milliseconds)

Wait for a timeout.

<Note>
  Deprecated: Use `await new Promise(r =&gt; setTimeout(r, ms))` instead.
</Note>

```ts
await runtime.page.waitForTimeout(0);
```

| Parameter      | Type     | Required | Description |
| -------------- | -------- | -------- | ----------- |
| `milliseconds` | `number` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitfortimeout)

***

### waitForFunction(pageFunction, options?, ...args)

Wait for a function to return true.

```ts
await runtime.page.waitForFunction('...');
```

| Parameter      | Type                                              | Required | Description |
| -------------- | ------------------------------------------------- | -------- | ----------- |
| `pageFunction` | `Function \| string`                              | Yes      | —           |
| `options`      | `{ timeout?: number; polling?: number \| "raf" }` | No       | —           |
| `args`         | `unknown[]`                                       | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforfunction)

***

### waitForNetworkIdle(options?)

Wait for network to be idle.

```ts
await runtime.page.waitForNetworkIdle();
```

| Parameter | Type                                 | Required | Description |
| --------- | ------------------------------------ | -------- | ----------- |
| `options` | `PuppeteerWaitForNetworkIdleOptions` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitfornetworkidle)

***

### waitForFrame(urlOrPredicate, options?)

Wait for a frame to appear.

<Note>
  Note: Predicate functions are not supported in RPC mode. Use URL string instead.
</Note>

```ts
await runtime.page.waitForFrame('...');
```

| Parameter        | Type                   | Required | Description |
| ---------------- | ---------------------- | -------- | ----------- |
| `urlOrPredicate` | `string`               | Yes      | —           |
| `options`        | `{ timeout?: number }` | No       | —           |

**Returns** `RemotePuppeteerFrame`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforframe)

***

### waitForFileChooser(options?)

Wait for a file chooser to appear.

```ts
await runtime.page.waitForFileChooser();
```

| Parameter | Type                   | Required | Description |
| --------- | ---------------------- | -------- | ----------- |
| `options` | `{ timeout?: number }` | No       | —           |

**Returns** `RemotePuppeteerFileChooser`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforfilechooser)

***

### waitForRequest(urlOrPredicate, options?)

Wait for a specific request.

<Note>
  Note: Predicate functions are not supported in RPC mode. Use URL string instead.
</Note>

```ts
await runtime.page.waitForRequest('...');
```

| Parameter        | Type                   | Required | Description |
| ---------------- | ---------------------- | -------- | ----------- |
| `urlOrPredicate` | `string`               | Yes      | —           |
| `options`        | `{ timeout?: number }` | No       | —           |

**Returns** `PuppeteerHTTPRequest`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforrequest)

***

### waitForResponse(urlOrPredicate, options?)

Wait for a specific response.

<Note>
  Note: Predicate functions are not supported in RPC mode. Use URL string instead.
</Note>

```ts
await runtime.page.waitForResponse('...');
```

| Parameter        | Type                   | Required | Description |
| ---------------- | ---------------------- | -------- | ----------- |
| `urlOrPredicate` | `string`               | Yes      | —           |
| `options`        | `{ timeout?: number }` | No       | —           |

**Returns** `PuppeteerHTTPResponse`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitforresponse)

***

### waitForDevicePrompt(options?)

Wait for a device prompt (e.g., Bluetooth, USB).

```ts
await runtime.page.waitForDevicePrompt();
```

| Parameter | Type                   | Required | Description |
| --------- | ---------------------- | -------- | ----------- |
| `options` | `{ timeout?: number }` | No       | —           |

**Returns** `{ devices: Array&lt;{ name: string; id: string }&gt;; select: (deviceId: string) =&gt; Promise&lt;void&gt;; cancel: () =&gt; Promise&lt;void&gt; }`

[Upstream docs](https://pptr.dev/api/puppeteer.page.waitfordeviceprompt)

***

## Screenshots & PDF

### screenshot(options?)

Take a screenshot (returns base64 string or Buffer).

```ts
await runtime.page.screenshot();
```

| Parameter | Type                         | Required | Description |
| --------- | ---------------------------- | -------- | ----------- |
| `options` | `PuppeteerScreenshotOptions` | No       | —           |

**Returns** `string \| Buffer`

[Upstream docs](https://pptr.dev/api/puppeteer.page.screenshot)

***

### pdf(options?)

Generate a PDF (returns base64 string or Buffer).

```ts
await runtime.page.pdf();
```

| Parameter | Type                  | Required | Description |
| --------- | --------------------- | -------- | ----------- |
| `options` | `PuppeteerPDFOptions` | No       | —           |

**Returns** `string \| Buffer`

[Upstream docs](https://pptr.dev/api/puppeteer.page.pdf)

***

## Evaluation

### evaluate(pageFunction, ...args)

Evaluate JavaScript in the page context.

```ts
await runtime.page.evaluate('...');
```

| Parameter      | Type                 | Required | Description |
| -------------- | -------------------- | -------- | ----------- |
| `pageFunction` | `Function \| string` | Yes      | —           |
| `args`         | `unknown[]`          | No       | —           |

**Returns** `T`

[Upstream docs](https://pptr.dev/api/puppeteer.page.evaluate)

***

### \$eval(selector, pageFunction, ...args)

Evaluate JavaScript on a selected element.

```ts
await runtime.page.$eval('...', '...');
```

| Parameter      | Type                 | Required | Description |
| -------------- | -------------------- | -------- | ----------- |
| `selector`     | `string`             | Yes      | —           |
| `pageFunction` | `Function \| string` | Yes      | —           |
| `args`         | `unknown[]`          | No       | —           |

**Returns** `T`

[Upstream docs](https://pptr.dev/api/puppeteer.page._eval)

***

### \$\$eval(selector, pageFunction, ...args)

Evaluate JavaScript on all matching elements.

```ts
await runtime.page.$$eval('...', '...');
```

| Parameter      | Type                 | Required | Description |
| -------------- | -------------------- | -------- | ----------- |
| `selector`     | `string`             | Yes      | —           |
| `pageFunction` | `Function \| string` | Yes      | —           |
| `args`         | `unknown[]`          | No       | —           |

**Returns** `T`

[Upstream docs](https://pptr.dev/api/puppeteer.page.__eval)

***

### evaluateHandle(pageFunction, ...args)

Evaluate handle (returns a JSHandle).

<Note>
  Note: Handles are not fully supported in RPC mode - use evaluate instead.
</Note>

```ts
await runtime.page.evaluateHandle('...');
```

| Parameter      | Type                 | Required | Description |
| -------------- | -------------------- | -------- | ----------- |
| `pageFunction` | `Function \| string` | Yes      | —           |
| `args`         | `unknown[]`          | No       | —           |

**Returns** `unknown`

[Upstream docs](https://pptr.dev/api/puppeteer.page.evaluatehandle)

***

### evaluateOnNewDocument(pageFunction, ...args)

Add a script to evaluate when a new document is created.

```ts
await runtime.page.evaluateOnNewDocument('...');
```

| Parameter      | Type                 | Required | Description |
| -------------- | -------------------- | -------- | ----------- |
| `pageFunction` | `Function \| string` | Yes      | —           |
| `args`         | `unknown[]`          | No       | —           |

**Returns** `{ identifier: string }`

[Upstream docs](https://pptr.dev/api/puppeteer.page.evaluateonnewdocument)

***

## Cookies

### cookies(...urls)

Get all cookies.

```ts
await runtime.page.cookies();
```

| Parameter | Type       | Required | Description |
| --------- | ---------- | -------- | ----------- |
| `urls`    | `string[]` | No       | —           |

**Returns** `PuppeteerCookie[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page.cookies)

***

### setCookie(...cookies)

Set cookies.

```ts
await runtime.page.setCookie(/* PuppeteerCookie[] */);
```

| Parameter | Type                | Required | Description |
| --------- | ------------------- | -------- | ----------- |
| `cookies` | `PuppeteerCookie[]` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setcookie)

***

### deleteCookie(...cookies)

Delete cookies.

```ts
await runtime.page.deleteCookie(/* PuppeteerCookie[] */);
```

| Parameter | Type                | Required | Description |
| --------- | ------------------- | -------- | ----------- |
| `cookies` | `PuppeteerCookie[]` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.deletecookie)

***

## Lifecycle

### bringToFront()

Bring page to front.

```ts
await runtime.page.bringToFront();
```

[Upstream docs](https://pptr.dev/api/puppeteer.page.bringtofront)

***

### close()

Close the page.

```ts
await runtime.page.close();
```

[Upstream docs](https://pptr.dev/api/puppeteer.page.close)

***

## Other

### emulateMediaType(type?)

Emulate media type.

```ts
await runtime.page.emulateMediaType();
```

| Parameter | Type                          | Required | Description |
| --------- | ----------------------------- | -------- | ----------- |
| `type`    | `'screen' \| 'print' \| null` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatemediatype)

***

### emulateMediaFeatures(features?)

Emulate media features.

```ts
await runtime.page.emulateMediaFeatures();
```

| Parameter  | Type                                           | Required | Description |
| ---------- | ---------------------------------------------- | -------- | ----------- |
| `features` | `Array&lt;{ name: string; value: string }&gt;` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatemediafeatures)

***

### emulateTimezone(timezoneId?)

Emulate timezone.

```ts
await runtime.page.emulateTimezone();
```

| Parameter    | Type     | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `timezoneId` | `string` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatetimezone)

***

### emulateVisionDeficiency(type?)

Emulate vision deficiency.

```ts
await runtime.page.emulateVisionDeficiency();
```

| Parameter | Type                                                                                             | Required | Description |
| --------- | ------------------------------------------------------------------------------------------------ | -------- | ----------- |
| `type`    | `'none' \| 'achromatopsia' \| 'deuteranopia' \| 'protanopia' \| 'tritanopia' \| 'blurredVision'` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatevisiondeficiency)

***

### setGeolocation(geolocation)

Set geolocation.

```ts
await runtime.page.setGeolocation(/* PuppeteerGeolocation */);
```

| Parameter     | Type                   | Required | Description |
| ------------- | ---------------------- | -------- | ----------- |
| `geolocation` | `PuppeteerGeolocation` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setgeolocation)

***

### setUserAgent(userAgent)

Set user agent.

```ts
await runtime.page.setUserAgent('...');
```

| Parameter   | Type     | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `userAgent` | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setuseragent)

***

### setExtraHTTPHeaders(headers)

Set extra HTTP headers.

```ts
await runtime.page.setExtraHTTPHeaders(/* Record<string, string> */);
```

| Parameter | Type                           | Required | Description |
| --------- | ------------------------------ | -------- | ----------- |
| `headers` | `Record&lt;string, string&gt;` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setextrahttpheaders)

***

### createCDPSession()

Create a CDP session.

<Note>
  Note: Returns a session identifier in RPC mode (not a live CDPSession).
</Note>

```ts
await runtime.page.createCDPSession();
```

**Returns** `{ sessionId: string }`

[Upstream docs](https://pptr.dev/api/puppeteer.page.createcdpsession)

***

### sendCDP(method, params?)

Send a CDP command directly.

```ts
await runtime.page.sendCDP('...');
```

| Parameter | Type                            | Required | Description |
| --------- | ------------------------------- | -------- | ----------- |
| `method`  | `string`                        | Yes      | —           |
| `params`  | `Record&lt;string, unknown&gt;` | No       | —           |

**Returns** `T`

***

### metrics()

Get metrics.

```ts
await runtime.page.metrics();
```

**Returns** `Record&lt;string, number&gt;`

[Upstream docs](https://pptr.dev/api/puppeteer.page.metrics)

***

### setJavaScriptEnabled(enabled)

Set JavaScript enabled/disabled.

```ts
await runtime.page.setJavaScriptEnabled(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setjavascriptenabled)

***

### setCacheEnabled(enabled)

Set cache enabled/disabled.

```ts
await runtime.page.setCacheEnabled(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setcacheenabled)

***

### setOfflineMode(enabled)

Set offline mode.

```ts
await runtime.page.setOfflineMode(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setofflinemode)

***

### emulateNetworkConditions(conditions)

Emulate network conditions.

```ts
await runtime.page.emulateNetworkConditions(/* conditions */);
```

| Parameter    | Type                                                                                                  | Required | Description |
| ------------ | ----------------------------------------------------------------------------------------------------- | -------- | ----------- |
| `conditions` | `{ offline: boolean; downloadThroughput: number; uploadThroughput: number; latency: number } \| null` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatenetworkconditions)

***

### addScriptTag(options)

Add script tag.

```ts
await runtime.page.addScriptTag(/* { url?: string; path?: string; content?: string; type?: string } */);
```

| Parameter | Type                                                               | Required | Description |
| --------- | ------------------------------------------------------------------ | -------- | ----------- |
| `options` | `{ url?: string; path?: string; content?: string; type?: string }` | Yes      | —           |

**Returns** `PuppeteerSerializedElement`

[Upstream docs](https://pptr.dev/api/puppeteer.page.addscripttag)

***

### addStyleTag(options)

Add style tag.

```ts
await runtime.page.addStyleTag(/* { url?: string; path?: string; content?: string } */);
```

| Parameter | Type                                                | Required | Description |
| --------- | --------------------------------------------------- | -------- | ----------- |
| `options` | `{ url?: string; path?: string; content?: string }` | Yes      | —           |

**Returns** `PuppeteerSerializedElement`

[Upstream docs](https://pptr.dev/api/puppeteer.page.addstyletag)

***

### setRequestInterception(enabled)

Set request interception enabled/disabled.

```ts
await runtime.page.setRequestInterception(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setrequestinterception)

***

### authenticate(credentials)

Authenticate with HTTP auth.

```ts
await runtime.page.authenticate(/* credentials */);
```

| Parameter     | Type                                             | Required | Description |
| ------------- | ------------------------------------------------ | -------- | ----------- |
| `credentials` | `{ username: string; password: string } \| null` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.authenticate)

***

### mainFrame()

Get the main frame.

```ts
runtime.page.mainFrame();
```

**Returns** `RemotePuppeteerFrame`

[Upstream docs](https://pptr.dev/api/puppeteer.page.mainframe)

***

### frames()

Get all frames.

```ts
await runtime.page.frames();
```

**Returns** `RemotePuppeteerFrame[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page.frames)

***

### setDefaultNavigationTimeout(timeout)

Set the default navigation timeout.

```ts
await runtime.page.setDefaultNavigationTimeout(0);
```

| Parameter | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `timeout` | `number` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setdefaultnavigationtimeout)

***

### setDefaultTimeout(timeout)

Set the default timeout.

```ts
await runtime.page.setDefaultTimeout(0);
```

| Parameter | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `timeout` | `number` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setdefaulttimeout)

***

### getDefaultNavigationTimeout()

Get the default navigation timeout.

```ts
runtime.page.getDefaultNavigationTimeout();
```

**Returns** `number`

***

### getDefaultTimeout()

Get the default timeout.

```ts
runtime.page.getDefaultTimeout();
```

**Returns** `number`

***

### setBypassCSP(enabled)

Toggle bypassing Content-Security-Policy.

```ts
await runtime.page.setBypassCSP(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setbypasscsp)

***

### removeScriptToEvaluateOnNewDocument(identifier)

Remove an injected script.

```ts
await runtime.page.removeScriptToEvaluateOnNewDocument('...');
```

| Parameter    | Type     | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `identifier` | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.removescripttoevaluateonnewdocument)

***

### removeExposedFunction(name)

Remove an exposed function.

```ts
await runtime.page.removeExposedFunction('...');
```

| Parameter | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `name`    | `string` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.removeexposedfunction)

***

### emulate(device)

Emulate a device (viewport + user agent).

```ts
await runtime.page.emulate(/* PuppeteerDevice */);
```

| Parameter | Type              | Required | Description |
| --------- | ----------------- | -------- | ----------- |
| `device`  | `PuppeteerDevice` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulate)

***

### emulateCPUThrottling(factor)

Emulate CPU throttling.

```ts
await runtime.page.emulateCPUThrottling(/* factor */);
```

| Parameter | Type             | Required | Description |
| --------- | ---------------- | -------- | ----------- |
| `factor`  | `number \| null` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulatecputhrottling)

***

### emulateIdleState(overrides?)

Emulate idle state.

```ts
await runtime.page.emulateIdleState();
```

| Parameter   | Type                     | Required | Description |
| ----------- | ------------------------ | -------- | ----------- |
| `overrides` | `PuppeteerIdleOverrides` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.emulateidlestate)

***

### setBypassServiceWorker(bypass)

Set service worker bypass.

```ts
await runtime.page.setBypassServiceWorker(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `bypass`  | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setbypassserviceworker)

***

### setDragInterception(enabled)

Set drag interception.

```ts
await runtime.page.setDragInterception(true);
```

| Parameter | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `enabled` | `boolean` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.setdraginterception)

***

### target()

Get the target for this page.

```ts
await runtime.page.target();
```

**Returns** `PuppeteerTarget`

[Upstream docs](https://pptr.dev/api/puppeteer.page.target)

***

### workers()

Get all web workers for this page.

```ts
await runtime.page.workers();
```

**Returns** `PuppeteerWebWorker[]`

[Upstream docs](https://pptr.dev/api/puppeteer.page.workers)

***

### windowId()

Get the window ID.

```ts
await runtime.page.windowId();
```

**Returns** `number`

***

### resize(options)

Resize the page.

```ts
await runtime.page.resize(/* { width: number; height: number } */);
```

| Parameter | Type                                | Required | Description |
| --------- | ----------------------------------- | -------- | ----------- |
| `options` | `{ width: number; height: number }` | Yes      | —           |

***

### queryObjects(prototypeHandle)

Query all objects of a given prototype.

```ts
await runtime.page.queryObjects(/* RemotePuppeteerElementHandle */);
```

| Parameter         | Type                           | Required | Description |
| ----------------- | ------------------------------ | -------- | ----------- |
| `prototypeHandle` | `RemotePuppeteerElementHandle` | Yes      | —           |

**Returns** `RemotePuppeteerElementHandle`

[Upstream docs](https://pptr.dev/api/puppeteer.page.queryobjects)

***

### openDevTools(options?)

Open DevTools. Only works in headful mode.

```ts
await runtime.page.openDevTools();
```

| Parameter | Type                                                        | Required | Description |
| --------- | ----------------------------------------------------------- | -------- | ----------- |
| `options` | `{ docking?: 'right' \| 'bottom' \| 'left' \| 'undocked' }` | No       | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.page.opendevtools)

***

## Mouse

### mouse.click(x, y, options?)

Click at specific coordinates.

```ts
await runtime.page.mouse.click(0, 0);
```

| Parameter | Type                         | Required | Description |
| --------- | ---------------------------- | -------- | ----------- |
| `x`       | `number`                     | Yes      | —           |
| `y`       | `number`                     | Yes      | —           |
| `options` | `PuppeteerMouseClickOptions` | No       | —           |

***

### mouse.move(x, y, options?)

Move mouse to specific coordinates.

```ts
await runtime.page.mouse.move(0, 0);
```

| Parameter | Type                        | Required | Description |
| --------- | --------------------------- | -------- | ----------- |
| `x`       | `number`                    | Yes      | —           |
| `y`       | `number`                    | Yes      | —           |
| `options` | `PuppeteerMouseMoveOptions` | No       | —           |

***

### mouse.down(options?)

Press mouse button down.

```ts
await runtime.page.mouse.down();
```

| Parameter | Type                    | Required | Description |
| --------- | ----------------------- | -------- | ----------- |
| `options` | `PuppeteerMouseOptions` | No       | —           |

***

### mouse.up(options?)

Release mouse button.

```ts
await runtime.page.mouse.up();
```

| Parameter | Type                    | Required | Description |
| --------- | ----------------------- | -------- | ----------- |
| `options` | `PuppeteerMouseOptions` | No       | —           |

***

### mouse.wheel(options?)

Scroll mouse wheel.

```ts
await runtime.page.mouse.wheel();
```

| Parameter | Type                         | Required | Description |
| --------- | ---------------------------- | -------- | ----------- |
| `options` | `PuppeteerMouseWheelOptions` | No       | —           |

***

### mouse.drag(start, target)

Dispatches a drag event.

```ts
await runtime.page.mouse.drag(/* PuppeteerPoint */, /* PuppeteerPoint */);
```

| Parameter | Type             | Required | Description |
| --------- | ---------------- | -------- | ----------- |
| `start`   | `PuppeteerPoint` | Yes      | —           |
| `target`  | `PuppeteerPoint` | Yes      | —           |

**Returns** `PuppeteerDragData`

***

### mouse.dragAndDrop(start, target, options?)

Perform a drag and drop operation.

```ts
await runtime.page.mouse.dragAndDrop(/* PuppeteerPoint */, /* PuppeteerPoint */);
```

| Parameter | Type                 | Required | Description |
| --------- | -------------------- | -------- | ----------- |
| `start`   | `PuppeteerPoint`     | Yes      | —           |
| `target`  | `PuppeteerPoint`     | Yes      | —           |
| `options` | `{ delay?: number }` | No       | —           |

***

### mouse.dragEnter(target, data)

Dispatches a dragenter event.

```ts
await runtime.page.mouse.dragEnter(/* PuppeteerPoint */, /* PuppeteerDragData */);
```

| Parameter | Type                | Required | Description |
| --------- | ------------------- | -------- | ----------- |
| `target`  | `PuppeteerPoint`    | Yes      | —           |
| `data`    | `PuppeteerDragData` | Yes      | —           |

***

### mouse.dragOver(target, data)

Dispatches a dragover event.

```ts
await runtime.page.mouse.dragOver(/* PuppeteerPoint */, /* PuppeteerDragData */);
```

| Parameter | Type                | Required | Description |
| --------- | ------------------- | -------- | ----------- |
| `target`  | `PuppeteerPoint`    | Yes      | —           |
| `data`    | `PuppeteerDragData` | Yes      | —           |

***

### mouse.drop(target, data)

Performs a dragenter, dragover, and drop in sequence.

```ts
await runtime.page.mouse.drop(/* PuppeteerPoint */, /* PuppeteerDragData */);
```

| Parameter | Type                | Required | Description |
| --------- | ------------------- | -------- | ----------- |
| `target`  | `PuppeteerPoint`    | Yes      | —           |
| `data`    | `PuppeteerDragData` | Yes      | —           |

***

### mouse.reset()

Resets the mouse to the default state.

```ts
await runtime.page.mouse.reset();
```

***

## Keyboard

### keyboard.down(key, options?)

Dispatches a `keydown` event.

<Note>
  If `key` is a single character and no modifier keys besides `Shift` are being held down,
  a `keypress`/`input` event will also be generated. The `text` option can be specified
  to force an input event to be generated.

  Modifier keys DO affect `keyboard.down`. Holding down `Shift` will type the text in upper case.
</Note>

```ts
await runtime.page.keyboard.down(/* PuppeteerKeyInput */);
```

| Parameter | Type                      | Required | Description                                |
| --------- | ------------------------- | -------- | ------------------------------------------ |
| `key`     | `PuppeteerKeyInput`       | Yes      | Name of key to press, such as `ArrowLeft`. |
| `options` | `PuppeteerKeyDownOptions` | No       | Options for the key down event.            |

[Upstream docs](https://pptr.dev/api/puppeteer.keyboard.down)

***

### keyboard.up(key)

Dispatches a `keyup` event.

```ts
await runtime.page.keyboard.up(/* PuppeteerKeyInput */);
```

| Parameter | Type                | Required | Description                                  |
| --------- | ------------------- | -------- | -------------------------------------------- |
| `key`     | `PuppeteerKeyInput` | Yes      | Name of key to release, such as `ArrowLeft`. |

[Upstream docs](https://pptr.dev/api/puppeteer.keyboard.up)

***

### keyboard.press(key, options?)

Shortcut for `Keyboard.down` and `Keyboard.up`.

<Note>
  If `key` is a single character and no modifier keys besides `Shift` are being held down,
  a `keypress`/`input` event will also be generated. The `text` option can be specified
  to force an input event to be generated.

  Modifier keys DO affect `keyboard.press`. Holding down `Shift` will type the text in upper case.
</Note>

```ts
await runtime.page.keyboard.press(/* PuppeteerKeyInput */);
```

| Parameter | Type                       | Required | Description                                                                |
| --------- | -------------------------- | -------- | -------------------------------------------------------------------------- |
| `key`     | `PuppeteerKeyInput`        | Yes      | Name of key to press, such as `ArrowLeft`.                                 |
| `options` | `PuppeteerKeyPressOptions` | No       | Options for the key press event including `delay`, `text`, and `commands`. |

[Upstream docs](https://pptr.dev/api/puppeteer.keyboard.press)

***

### keyboard.sendCharacter(char)

Dispatches a `keypress` and `input` event. This does not send a `keydown` or `keyup` event.

<Note>
  Modifier keys DO NOT affect `keyboard.sendCharacter`. Holding down `Shift` will not
  type the text in upper case.
</Note>

```ts
await runtime.page.keyboard.sendCharacter('...');
```

| Parameter | Type     | Required | Description                      |
| --------- | -------- | -------- | -------------------------------- |
| `char`    | `string` | Yes      | Character to send into the page. |

[Upstream docs](https://pptr.dev/api/puppeteer.keyboard.sendcharacter)

***

### keyboard.type(text, options?)

Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.

<Note>
  To press a special key, like `Control` or `ArrowDown`, use `Keyboard.press`.

  Modifier keys DO NOT affect `keyboard.type`. Holding down `Shift` will not type the text
  in upper case.
</Note>

```ts
await runtime.page.keyboard.type('...');
```

| Parameter | Type                           | Required | Description                                               |
| --------- | ------------------------------ | -------- | --------------------------------------------------------- |
| `text`    | `string`                       | Yes      | A text to type into a focused element.                    |
| `options` | `PuppeteerKeyboardTypeOptions` | No       | Options for typing including `delay` between key presses. |

[Upstream docs](https://pptr.dev/api/puppeteer.keyboard.type)

***

## Touchscreen

### touchscreen.tap(x, y)

Dispatches a `touchstart` and `touchend` event (simulates a tap).

```ts
await runtime.page.touchscreen.tap(0, 0);
```

| Parameter | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `x`       | `number` | Yes      | —           |
| `y`       | `number` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.touchscreen.tap)

***

### touchscreen.touchStart(x, y)

Dispatches a `touchstart` event.

<Note>
  Returns a TouchHandle that can be used to dispatch `touchMove` and `touchEnd` events
  for this specific touch point. This allows tracking individual touches in multi-touch scenarios.

  The returned TouchHandle has:

  * `move(x, y)`: Dispatches a touchmove event for this touch
  * `end()`: Dispatches a touchend event for this touch
</Note>

````ts
Performing a swipe gesture:
```ts
const touch = await page.touchscreen.touchStart(100, 100);
await touch.move(200, 100);
await touch.move(300, 100);
await touch.end();
````

````

| Parameter | Type | Required | Description |
|---|---|---|---|
| `x` | `number` | Yes | — |
| `y` | `number` | Yes | — |

**Returns** `TouchHandle`
— A TouchHandle for controlling this touch point.

[Upstream docs](https://pptr.dev/api/puppeteer.touchscreen.touchstart)

---

### touchscreen.touchMove(x, y)

Dispatches a `touchmove` event on the active touch.

<Note>
Note: Not every `touchMove` call results in a `touchmove` event being emitted,
depending on the browser's optimizations.

For more precise control over individual touches, use `touchStart()` which returns
a TouchHandle with its own `move()` method.
</Note>

```ts
await runtime.page.touchscreen.touchMove(0, 0);
````

| Parameter | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `x`       | `number` | Yes      | —           |
| `y`       | `number` | Yes      | —           |

[Upstream docs](https://pptr.dev/api/puppeteer.touchscreen.touchmove)

***

### touchscreen.touchEnd()

Dispatches a `touchend` event.

```ts
await runtime.page.touchscreen.touchEnd();
```

[Upstream docs](https://pptr.dev/api/puppeteer.touchscreen.touchend)

***