puppeteer/website/versioned_docs/version-21.3.8/api/puppeteer.webworker.evaluate.md
release-please[bot] ddbb43cd09
chore: release main (#11086)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-10-06 11:48:06 +00:00

1.3 KiB

sidebar_label
WebWorker.evaluate

WebWorker.evaluate() method

If the function passed to the worker.evaluate returns a Promise, then worker.evaluate would wait for the promise to resolve and return its value. If the function passed to the worker.evaluate returns a non-serializable value, then worker.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals. Shortcut for await worker.executionContext()).evaluate(pageFunction, ...args).

Signature:

class WebWorker {
  evaluate<
    Params extends unknown[],
    Func extends EvaluateFunc<Params> = EvaluateFunc<Params>,
  >(
    pageFunction: Func | string,
    ...args: Params
  ): Promise<Awaited<ReturnType<Func>>>;
}

Parameters

Parameter Type Description
pageFunction Func | string Function to be evaluated in the worker context.
args Params Arguments to pass to pageFunction.

Returns:

Promise<Awaited<ReturnType<Func>>>

Promise which resolves to the return value of pageFunction.