playwright/docs/src/api/class-worker.md

106 lines
3.2 KiB
Markdown
Raw Normal View History

# class: Worker
The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). `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());
```
```java
page.onWorker(worker -> {
System.out.println("Worker created: " + worker.url());
worker.onClose(worker1 -> System.out.println("Worker destroyed: " + worker1.url()));
});
System.out.println("Current workers:");
for (Worker worker : page.workers())
System.out.println(" " + worker.url());
```
```py
def handle_worker(worker):
print("worker created: " + worker.url)
worker.on("close", lambda: print("worker destroyed: " + worker.url))
page.on('worker', handle_worker)
print("current workers:")
for worker in page.workers:
print(" " + worker.url)
```
```csharp
page.Worker += (_, worker) =>
{
Console.WriteLine($"Worker created: {worker.Url}");
worker.Close += (_, _) => Console.WriteLine($"Worker closed {worker.Url}");
};
Console.WriteLine("Current Workers:");
foreach(var pageWorker in page.Workers)
{
Console.WriteLine($"\tWorker: {pageWorker.Url}");
}
```
## event: Worker.close
- argument: <[Worker]>
Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is terminated.
## async method: Worker.evaluate
- returns: <[Serializable]>
2021-02-01 11:43:26 -08:00
Returns the return value of [`param: expression`].
2021-02-01 11:43:26 -08:00
If the function passed to the [`method: Worker.evaluate`] returns a [Promise], then [`method: Worker.evaluate`] would wait for the promise
to resolve and return its value.
If the function passed to the [`method: Worker.evaluate`] returns a non-[Serializable] value, then [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some
2021-02-01 11:43:26 -08:00
additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
### param: Worker.evaluate.expression = %%-evaluate-expression-%%
### param: Worker.evaluate.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`].
## async method: Worker.evaluateHandle
- returns: <[JSHandle]>
2021-02-01 11:43:26 -08:00
Returns the return value of [`param: expression`] as a [JSHandle].
2021-02-01 11:43:26 -08:00
The only difference between [`method: Worker.evaluate`] and
[`method: Worker.evaluateHandle`] is that [`method: Worker.evaluateHandle`]
2021-02-01 11:43:26 -08:00
returns [JSHandle].
2021-02-01 11:43:26 -08:00
If the function passed to the [`method: Worker.evaluateHandle`] returns a [Promise], then [`method: Worker.evaluateHandle`] would wait for
the promise to resolve and return its value.
### param: Worker.evaluateHandle.expression = %%-evaluate-expression-%%
### param: Worker.evaluateHandle.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`].
## method: Worker.url
- returns: <[string]>
## async method: Worker.waitForClose
* langs: csharp, java
- returns: <[Worker]>
Performs action and waits for the Worker to close.
### option: Worker.waitForClose.timeout = %%-wait-for-event-timeout-%%