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

1.3 KiB

sidebar_label
WebWorker.evaluateHandle

WebWorker.evaluateHandle() method

The only difference between worker.evaluate and worker.evaluateHandle is that worker.evaluateHandle returns in-page object (JSHandle). If the function passed to the worker.evaluateHandle returns a Promise, then worker.evaluateHandle would wait for the promise to resolve and return its value. Shortcut for await worker.executionContext()).evaluateHandle(pageFunction, ...args)

Signature:

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

Parameters

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

Returns:

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

Promise which resolves to the return value of pageFunction.