github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
f07ad2c661
puppeteer/docs/api/puppeteer.framewaitforfunctionoptions.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

3.1 KiB
Raw Blame History

sidebar_label
FrameWaitForFunctionOptions

FrameWaitForFunctionOptions interface

Signature:

export interface FrameWaitForFunctionOptions

Properties

Property Modifiers Type Description Default
polling? 'raf' | 'mutation' | number

(Optional) An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values:

- raf - to constantly execute pageFunction in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes.

- mutation - to execute pageFunction on every DOM mutation.
timeout? number (Optional) Maximum time to wait in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable the timeout. Puppeteer's default timeout can be changed using Page.setDefaultTimeout().