mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForNavigation](./puppeteer.page.waitfornavigation.md)
|
|
|
|
## Page.waitForNavigation() method
|
|
|
|
This resolves when the page navigates to a new URL or reloads. It is useful when you run code that will indirectly cause the page to navigate. Consider this example:
|
|
|
|
```js
|
|
const [response] = await Promise.all([
|
|
page.waitForNavigation(), // The promise resolves after navigation has finished
|
|
page.click('a.my-link'), // Clicking the link will indirectly cause a navigation
|
|
]);
|
|
|
|
```
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
waitForNavigation(options?: WaitForOptions): Promise<HTTPResponse | null>;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | Navigation parameters which might have the following properties: |
|
|
|
|
<b>Returns:</b>
|
|
|
|
Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null>
|
|
|
|
Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with `null`.
|
|
|
|
## Remarks
|
|
|
|
NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
|
|
|
Shortcut for [page.mainFrame().waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md).
|
|
|