跳到正文
本页尚未翻译成中文,以下为英文原文。 查看英文版

Worker ​

Added in: v1.8

The 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.

js
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 async

Returns 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

  • pageFunction function() | string

    Function to be evaluated in the worker context.

  • arg EvaluationArgument (optional)

    Optional argument to pass to pageFunction.

Returns

  • Promise<Serializable>

worker.evaluateHandle() ​

Added in: v1.8 async

Returns 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

  • pageFunction function() | string

    Function to be evaluated in the worker context.

  • arg EvaluationArgument (optional)

    Optional argument to pass to pageFunction.

Returns

  • Promise<JSHandle>

worker.url() ​

Added in: v1.8

Returns

  • string

worker.waitForEvent() ​

Added in: v1.57 async

Waits 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

js
// 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 string

    Event name, same one typically passed into *.on(event).

  • optionsOrPredicate function() | Object (optional)

    Either a predicate that receives an event or an options object. Optional.

    • predicate function()

      Receives the event data and resolves to truthy value when the waiting should resolve.

    • timeout float (optional)

      Maximum time to wait for in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.

  • options Object (optional)

    • predicate function() (optional)

      Receives the event data and resolves to truthy value when the waiting should resolve.

    • signal AbortSignal (optional) Added in: v1.62

      Allows 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 using browserContext.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.

Returns

  • Promise<any>

Events ​

worker.on('close') ​

Added in: v1.8

Emitted when this dedicated WebWorker is terminated.

Event data

  • Worker

worker.on('console') ​

Added in: v1.57

Emitted when JavaScript within the worker calls one of console API methods, e.g. console.log or console.dir.

Event data

  • ConsoleMessage

基于 Apache 2.0 许可证发布。