mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
f07ad2c661
This PR updates the docs regarding configuring puppeteer. In addition, some changes have been made to the documentation generator to show default values on the documentation site. Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
40 lines
1.9 KiB
Markdown
40 lines
1.9 KiB
Markdown
---
|
|
sidebar_label: Frame.waitForXPath
|
|
---
|
|
|
|
# Frame.waitForXPath() method
|
|
|
|
> Warning: This API is now obsolete.
|
|
>
|
|
> Use [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md) 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()](./puppeteer.frame.waitforselector.md). That function behaves identically other than taking a CSS selector rather than an XPath.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
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](./puppeteer.waitforselectoroptions.md) | <i>(Optional)</i> options to configure the visiblity of the element and how long to wait before timing out. |
|
|
|
|
**Returns:**
|
|
|
|
Promise<[ElementHandle](./puppeteer.elementhandle.md)<Node> \| null>
|