puppeteer/docs/api/puppeteer.framewaitforfunctionoptions.polling.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
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

716 B

sidebar_label
FrameWaitForFunctionOptions.polling

FrameWaitForFunctionOptions.polling property

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.

Signature:

interface FrameWaitForFunctionOptions {
  polling?: 'raf' | 'mutation' | number;
}