mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
eedbb13ada
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
---
|
|
sidebar_label: Page.waitForNavigation
|
|
---
|
|
|
|
# Page.waitForNavigation() method
|
|
|
|
Waits for the page to navigate to a new URL or to reload. It is useful when you run code that will indirectly cause the page to navigate.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Page {
|
|
waitForNavigation(options?: WaitForOptions): Promise<HTTPResponse | null>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Navigation parameters which might have the following properties: |
|
|
|
|
**Returns:**
|
|
|
|
Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null>
|
|
|
|
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. - In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with `null`.
|
|
|
|
## Remarks
|
|
|
|
Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
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
|
|
]);
|
|
```
|