puppeteer/new-docs/puppeteer.frame.waitfor.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Frame](./puppeteer.frame.md) &gt; [waitFor](./puppeteer.frame.waitfor.md)

## Frame.waitFor() method

<b>Signature:</b>

```typescript
waitFor(selectorOrFunctionOrTimeout: string | number | Function, options?: {}, ...args: SerializableOrJSHandle[]): Promise<JSHandle | null>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  selectorOrFunctionOrTimeout | string \| number \| Function | a selector, predicate or timeout to wait for. |
|  options | {} | optional waiting parameters. |
|  args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)<!-- -->\[\] | arguments to pass to <code>pageFunction</code>. |

<b>Returns:</b>

Promise&lt;[JSHandle](./puppeteer.jshandle.md) \| null&gt;

## Remarks

This method behaves differently depending on the first parameter. If it's a `string`<!-- -->, it will be treated as a `selector` or `xpath` (if the string starts with `//`<!-- -->). This method then is a shortcut for [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md) or [Frame.waitForXPath()](./puppeteer.frame.waitforxpath.md)<!-- -->.

If the first argument is a function this method is a shortcut for [Frame.waitForFunction()](./puppeteer.frame.waitforfunction.md)<!-- -->.

If the first argument is a `number`<!-- -->, it's treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout.
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			`<!-- Do not edit this file. It is automatically generated by API Documenter. -->`

			`[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitFor](./puppeteer.frame.waitfor.md)`

			`## Frame.waitFor() method`

			`<b>Signature:</b>`

			```typescript
feat(types): add (and fix) `evaluateHandle` types (#6130) This change started as a small change to pull types from DefinitelyTyped over to Puppeteer for the `evaluateHandle` function but instead ended up also fixing what looks to be a long standing issue with our existing documentation. `evaluateHandle` can in fact return an `ElementHandle` rather than a `JSHandle`. Note that `ElementHandle` extends `JSHandle` so whilst the docs are technically correct (all ElementHandles are JSHandles) it's confusing because JSHandles don't have methods like `click` on them, but ElementHandles do. if you return something that is an HTML element: ``` const button = page.evaluateHandle(() => document.querySelector('button')); // this is an ElementHandle, not a JSHandle ``` Therefore I've updated the original docs and added a large explanation to the TSDoc for `page.evaluateHandle`. In TypeScript land we'll assume the function will return a `JSHandle` but you can tell TS otherwise via the generic argument, which can only be `JSHandle` (the default) or `ElementHandle`: ``` const button = page.evaluateHandle<ElementHandle>(() => document.querySelector('button')); ``` 2020-07-01 11:44:08 +00:00			`waitFor(selectorOrFunctionOrTimeout: string \| number \| Function, options?: {}, ...args: SerializableOrJSHandle[]): Promise<JSHandle \| null>;`
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			```

			`## Parameters`

			`\| Parameter \| Type \| Description \|`
			`\| --- \| --- \| --- \|`
chore(docs): document Frame class (#6188) * chore: document Frame class 2020-07-09 13:22:58 +00:00			`\| selectorOrFunctionOrTimeout \| string \\| number \\| Function \| a selector, predicate or timeout to wait for. \|`
			`\| options \| {} \| optional waiting parameters. \|`
			`\| args \| [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)<!-- -->\[\] \| arguments to pass to <code>pageFunction</code>. \|`
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00
			`<b>Returns:</b>`

			`Promise<[JSHandle](./puppeteer.jshandle.md) \\| null>`

chore(docs): document Frame class (#6188) * chore: document Frame class 2020-07-09 13:22:58 +00:00			`## Remarks`

			This method behaves differently depending on the first parameter. If it's a `string`<!-- -->, it will be treated as a `selector` or `xpath` (if the string starts with `//`<!-- -->). This method then is a shortcut for [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md) or [Frame.waitForXPath()](./puppeteer.frame.waitforxpath.md)<!-- -->.

			`If the first argument is a function this method is a shortcut for [Frame.waitForFunction()](./puppeteer.frame.waitforfunction.md)<!-- -->.`

			If the first argument is a `number`<!-- -->, it's treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout.