puppeteer/docs/api/puppeteer.webworker.waitforfunction.md

sidebar_label

sidebar_label
WebWorker.waitForFunction

WebWorker.waitForFunction() method

Waits for the provided function, workerFunction, to return a truthy value when evaluated in the page's context.

Signature

class WebWorker {
  waitForFunction<
    Params extends unknown[],
    Func extends EvaluateFunc<Params> = EvaluateFunc<Params>,
  >(
    workerFunction: Func | string,
    options?: {
      polling?: number;
      timeout?: number;
      signal?: AbortSignal;
    },
    ...args: Params
  ): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
}

Parameters

Parameter	Type	Description
workerFunction	Func | string	Function to be evaluated in browser context until it returns a truthy value.
options	{ polling?: number; timeout?: number; signal?: AbortSignal; }	(Optional) Options for configuring waiting behavior.
args	Params

Returns:

Promise<HandleFor<Awaited<ReturnType<Func>>>>