Skip to main content
Version: 22.6.2

WebWorker.evaluateHandle() method

Evaluates a given function in the worker.

Signature:

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

Parameters

Parameter

Type

Description

func

Func | string

Function to be evaluated.

args

Params

Arguments to pass into func.

Returns:

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

A handle to the return value of func.

Remarks

If the given function returns a promise, evaluate will wait for the promise to resolve.

In general, you should use evaluateHandle if evaluate cannot serialize the return value properly or you need a mutable handle to the return object.