puppeteer/website/versioned_docs/version-22.6.3/api/puppeteer.framewaitforfunctionoptions.md
release-please[bot] a63b8305ac
chore: release main (#12190)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-04-05 13:11:52 +00:00

1.4 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().