Worker
Added in: v1.8The Worker class represents a WebWorker. worker event is emitted on the page object to signal a worker creation. close event is emitted on the worker object when the worker is gone.
page.on('worker', worker => {
console.log('Worker created: ' + worker.url());
worker.on('close', worker => console.log('Worker destroyed: ' + worker.url()));
});
console.log('Current workers:');
for (const worker of page.workers())
console.log(' ' + worker.url());Methods
worker.evaluate()
Added in: v1.8 asyncReturns the return value of pageFunction.
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() returns undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.
Arguments
pageFunctionfunction() | stringFunction to be evaluated in the worker context.
argEvaluationArgument(optional)Optional argument to pass to
pageFunction.
Returns
Promise<Serializable>
worker.evaluateHandle()
Added in: v1.8 asyncReturns the return value of pageFunction as a JSHandle.
The only difference between worker.evaluate() and worker.evaluateHandle() is that worker.evaluateHandle() returns 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.
Arguments
pageFunctionfunction() | stringFunction to be evaluated in the worker context.
argEvaluationArgument(optional)Optional argument to pass to
pageFunction.
Returns
Promise<JSHandle>
worker.url()
Added in: v1.8Returns
string
worker.waitForEvent()
Added in: v1.57 asyncWaits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the page is closed before the event is fired. Returns the event data value.
Usage
// Start waiting for download before clicking. Note no await.
const consolePromise = worker.waitForEvent('console');
await worker.evaluate('console.log(42)');
const consoleMessage = await consolePromise;Arguments
Event name, same one typically passed into
*.on(event).optionsOrPredicatefunction() | Object(optional)Either a predicate that receives an event or an options object. Optional.
predicatefunction()Receives the event data and resolves to truthy value when the waiting should resolve.
timeoutfloat(optional)Maximum time to wait for in milliseconds. Defaults to
0- no timeout. The default value can be changed viaactionTimeoutoption in the config, or by using thebrowserContext.setDefaultTimeout()orpage.setDefaultTimeout()methods.
predicatefunction()(optional)Receives the event data and resolves to truthy value when the waiting should resolve.
signalAbortSignal(optional) Added in: v1.62Allows to cancel the waiting using an
AbortSignal. If the signal is aborted, the waiting will be aborted and the operation will throw an error. Note that providing a signal does not disable the default timeout, which can be changed usingbrowserContext.setDefaultTimeout(); passtimeout: 0to disable the timeout entirely.
Returns
Promise<any>
Events
worker.on('close')
Added in: v1.8Emitted when this dedicated WebWorker is terminated.
Event data
Worker
worker.on('console')
Added in: v1.57Emitted when JavaScript within the worker calls one of console API methods, e.g. console.log or console.dir.
Event data
ConsoleMessage