puppeteer/new-docs/puppeteer.webworker.evaluate.md
Martin Splitt 44402b75a0
feat(new-docs): add tsdoc comments to WebWorker (#6029)
* feat(new-docs): add TSDoc comments to `WebWorker`

Co-authored-by: martinsplitt <martin@geekonaut.de>
2020-06-17 16:26:10 +01:00

1.3 KiB

Home > puppeteer > 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:

evaluate<ReturnType extends any>(pageFunction: Function | string, ...args: any[]): Promise<ReturnType>;

Parameters

Parameter Type Description
pageFunction Function | string Function to be evaluated in the worker context.
args any[] Arguments to pass to pageFunction.

Returns:

Promise<ReturnType>

Promise which resolves to the return value of pageFunction.