puppeteer/docs/api/puppeteer.frame.waitfortimeout.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
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
2022-10-24 09:07:05 +02:00

42 lines
1006 B
Markdown

---
sidebar_label: Frame.waitForTimeout
---
# Frame.waitForTimeout() method
> Warning: This API is now obsolete.
>
> Replace with `new Promise(r => setTimeout(r, milliseconds));`.
>
> Causes your script to wait for the given number of milliseconds.
#### Signature:
```typescript
class Frame {
waitForTimeout(milliseconds: number): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| ------------ | ------ | ----------------------------------- |
| milliseconds | number | the number of milliseconds to wait. |
**Returns:**
Promise&lt;void&gt;
## Remarks
It's generally recommended to not wait for a number of seconds, but instead use [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md), [Frame.waitForXPath()](./puppeteer.frame.waitforxpath.md) or [Frame.waitForFunction()](./puppeteer.frame.waitforfunction.md) to wait for exactly the conditions you want.
## Example
Wait for 1 second:
```ts
await frame.waitForTimeout(1000);
```