puppeteer/docs/api/puppeteer.frame.waitfornavigation.md

66 lines
1.1 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Frame.waitForNavigation
---
# Frame.waitForNavigation() method
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.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Frame {
abstract waitForNavigation(
options?: WaitForOptions
): Promise<HTTPResponse | null>;
2022-07-05 13:41:43 +00:00
}
```
## 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>
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&lt;[HTTPResponse](./puppeteer.httpresponse.md) \| null&gt;
A promise which resolves to the main resource response.
2022-07-05 13:41:43 +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'),
]);
```