puppeteer/website/versioned_docs/version-22.4.1/api/puppeteer.webworker.md
release-please[bot] e1a9b85bbe
chore: release main (#12056)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-03-08 13:12:17 +01:00

2.3 KiB

sidebar_label
WebWorker

WebWorker class

This class represents a WebWorker.

Signature:

export declare abstract class WebWorker extends EventEmitter<Record<EventType, unknown>>

Extends: EventEmitter<Record<EventType, unknown>>

Remarks

The events workercreated and workerdestroyed are emitted on the page object to signal the worker lifecycle.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebWorker class.

Example

page.on('workercreated', worker =>
  console.log('Worker created: ' + worker.url())
);
page.on('workerdestroyed', worker =>
  console.log('Worker destroyed: ' + worker.url())
);

console.log('Current workers:');
for (const worker of page.workers()) {
  console.log('  ' + worker.url());
}

Properties

Property Modifiers Type Description
client readonly CDPSession The CDP session client the WebWorker belongs to.

Methods

Method Modifiers Description
close()
evaluate(func, args) Evaluates a given function in the worker.
evaluateHandle(func, args) Evaluates a given function in the worker.
url() The URL of this web worker.