2022-07-05 13:41:43 +00:00
|
|
|
---
|
|
|
|
sidebar_label: Frame.waitForNavigation
|
|
|
|
---
|
|
|
|
|
|
|
|
# Frame.waitForNavigation() method
|
|
|
|
|
2022-08-10 21:34:29 +00:00
|
|
|
Waits for the frame to navigate. It is useful for when you run code which will indirectly cause the frame to navigate.
|
|
|
|
|
|
|
|
Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
|
|
|
|
2022-10-24 07:07:05 +00:00
|
|
|
#### Signature:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```typescript
|
|
|
|
class Frame {
|
2023-09-18 12:14:06 +00:00
|
|
|
abstract waitForNavigation(
|
|
|
|
options?: WaitForOptions
|
|
|
|
): Promise<HTTPResponse | null>;
|
2022-07-05 13:41:43 +00:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
<table><thead><tr><th>
|
2022-07-05 13:41:43 +00:00
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
Parameter
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
|
|
|
options
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[WaitForOptions](./puppeteer.waitforoptions.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
_(Optional)_ Options to configure waiting behavior.
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|
2022-07-05 13:41:43 +00:00
|
|
|
**Returns:**
|
|
|
|
|
|
|
|
Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null>
|
|
|
|
|
2023-09-18 12:14:06 +00:00
|
|
|
A promise which resolves to the main resource response.
|
2022-07-05 13:41:43 +00:00
|
|
|
|
2022-08-10 21:34:29 +00:00
|
|
|
## Example
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```ts
|
|
|
|
const [response] = await Promise.all([
|
|
|
|
// The navigation promise resolves after navigation has finished
|
|
|
|
frame.waitForNavigation(),
|
|
|
|
// Clicking the link will indirectly cause a navigation
|
|
|
|
frame.click('a.my-link'),
|
|
|
|
]);
|
|
|
|
```
|