puppeteer/website/versioned_docs/version-21.3.6/api/puppeteer.page.waitfornavigation.md

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:

class Page {
  waitForNavigation(options?: WaitForOptions): Promise<HTTPResponse | null>;
}

Parameters

Parameter	Type	Description
options	WaitForOptions	(Optional) Navigation parameters which might have the following properties:

Returns:

Promise<HTTPResponse | 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 to change the URL is considered a navigation.

Example

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
]);