43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitForNavigation](./puppeteer.frame.waitfornavigation.md)
|
|
|
|
## Frame.waitForNavigation() method
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
waitForNavigation(options?: {
|
|
timeout?: number;
|
|
waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
|
|
}): Promise<HTTPResponse | null>;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)<!-- -->\[\]; } | options to configure when the navigation is consided finished. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null>
|
|
|
|
a promise that resolves when the frame navigates to a new URL.
|
|
|
|
## Remarks
|
|
|
|
This resolves when the frame navigates to a new URL. It is useful for when you run code which will indirectly cause the frame to navigate. Consider this example:
|
|
|
|
```js
|
|
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'),
|
|
]);
|
|
|
|
```
|
|
Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
|
|