puppeteer/docs/api/puppeteer.frame.goto.md

93 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Frame.goto
---
# Frame.goto() method
Navigates the frame or page to the given `url`.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Frame {
2023-08-30 11:09:27 +00:00
abstract goto(
2022-07-05 13:41:43 +00:00
url: string,
options?: GoToOptions
2022-07-05 13:41:43 +00:00
): Promise<HTTPResponse | null>;
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
url
</td><td>
string
</td><td>
URL to navigate the frame to. The URL should include scheme, e.g. `https://`
</td></tr>
<tr><td>
options
</td><td>
[GoToOptions](./puppeteer.gotooptions.md)
</td><td>
_(Optional)_ Options to configure waiting behavior.
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;[HTTPResponse](./puppeteer.httpresponse.md) \| null&gt;
A promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
## Exceptions
2022-07-05 13:41:43 +00:00
If:
2022-07-05 13:41:43 +00:00
- there's an SSL error (e.g. in case of self-signed certificates).
2022-07-05 13:41:43 +00:00
- target URL is invalid.
- the timeout is exceeded during navigation.
- the remote server does not respond or is unreachable.
- the main resource failed to load.
2022-07-05 13:41:43 +00:00
## Remarks
2022-07-05 13:41:43 +00:00
Navigation to `about:blank` or navigation to the same URL with a different hash will succeed and return `null`.
2022-07-05 13:41:43 +00:00
:::warning
2022-07-05 13:41:43 +00:00
Headless shell mode doesn't support navigation to a PDF document. See the [upstream issue](https://crbug.com/761295).
2022-07-05 13:41:43 +00:00
:::
In headless shell, this method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling [HTTPResponse.status()](./puppeteer.httpresponse.status.md).