puppeteer/website/versioned_docs/version-21.3.8/api/puppeteer.frame.waitforxpath.md

sidebar_label
Frame.waitForXPath

Frame.waitForXPath() method

Warning: This API is now obsolete.

Use Frame.waitForSelector() with the xpath prefix.

Example: await frame.waitForSelector('xpath/' + xpathExpression)

The method evaluates the XPath expression relative to the Frame. If xpath starts with // instead of .//, the dot will be appended automatically.

Wait for the xpath to appear in page. If at the moment of calling the method the xpath already exists, the method will return immediately. If the xpath doesn't appear after the timeout milliseconds of waiting, the function will throw.

For a code example, see the example for Frame.waitForSelector(). That function behaves identically other than taking a CSS selector rather than an XPath.

Signature:

class Frame {
  waitForXPath(
    xpath: string,
    options?: WaitForSelectorOptions
  ): Promise<ElementHandle<Node> | null>;
}

Parameters

Parameter	Type	Description
xpath	string	the XPath expression to wait for.
options	WaitForSelectorOptions	(Optional) options to configure the visibility of the element and how long to wait before timing out.

Returns:

Promise<ElementHandle<Node> | null>