Worker extension type
@AvailableInWorkers("window_and_worker_except_service")
The Worker
interface of the
Web Workers API
represents a background task that can be created via script, which can send
messages back to its creator.
Creating a worker is done by calling the Worker("path/to/worker/script")
constructor.
Workers may themselves spawn new workers, as long as those workers are hosted at the same origin as the parent page.
Note that not all interfaces and functions are available to web workers. See Functions and classes available to Web Workers for details.
API documentation sourced from MDN Web Docs.
- on
- Implemented types
- Available extensions
Constructors
- Worker(JSAny scriptURL, [WorkerOptions options])
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- onerror ↔ EventHandler?
-
getter/setter pair
- onmessage ↔ EventHandler?
-
getter/setter pair
- onmessageerror ↔ EventHandler?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
addEventListener()
method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.inherited -
dispatchEvent(
Event event) → bool -
The
dispatchEvent()
method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually withdispatchEvent()
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
postMessage(
JSAny? message, [JSObject optionsOrTransfer]) → void - @AvailableInWorkers("window_and_worker_except_service")
-
removeEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
removeEventListener()
method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.inherited -
terminate(
) → void - @AvailableInWorkers("window_and_worker_except_service")
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited