puppeteer/docs/api/puppeteer.framewaitforfunctionoptions.md
Alex Rudenko 4dd4cb9292
feat: add AbortSignal to waitForFunction (#10078)
Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com>
2023-04-26 10:50:08 +02:00

3.5 KiB

sidebar_label
FrameWaitForFunctionOptions

FrameWaitForFunctionOptions interface

Signature:

export interface FrameWaitForFunctionOptions

Properties

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

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.

signal optional AbortSignal A signal object that allows you to cancel a waitForFunction call.
timeout optional number 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().