Interface WorkerGlobalScope

This Web Workers API interface is an interface representing the scope of any worker. Workers have no browsing context; this scope contains the information usually conveyed by Window objects — in this case event handlers, the console or the associated WorkerNavigator object. Each WorkerGlobalScope has its own event loop.

interface WorkerGlobalScope {
    caches: CacheStorage;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    fonts: FontFaceSet;
    indexedDB: IDBFactory;
    isSecureContext: boolean;
    location: WorkerLocation;
    navigator: WorkerNavigator;
    onerror: ((this: WorkerGlobalScope, ev: ErrorEvent) => any);
    onlanguagechange: ((this: WorkerGlobalScope, ev: Event) => any);
    onoffline: ((this: WorkerGlobalScope, ev: Event) => any);
    ononline: ((this: WorkerGlobalScope, ev: Event) => any);
    onrejectionhandled: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any);
    onunhandledrejection: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any);
    origin: string;
    performance: Performance;
    self: WorkerGlobalScope & typeof globalThis;
    addEventListener<K>(type: K, listener: ((this: WorkerGlobalScope, ev: WorkerGlobalScopeEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    atob(data: string): string;
    btoa(data: string): string;
    clearInterval(id: number): void;
    clearTimeout(id: number): void;
    createImageBitmap(image: ImageBitmapSource, options?: ImageBitmapOptions): Promise<ImageBitmap>;
    createImageBitmap(image: ImageBitmapSource, sx: number, sy: number, sw: number, sh: number, options?: ImageBitmapOptions): Promise<ImageBitmap>;
    dispatchEvent(event: Event): boolean;
    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    importScripts(...urls: (string | URL)[]): void;
    queueMicrotask(callback: VoidFunction): void;
    removeEventListener<K>(type: K, listener: ((this: WorkerGlobalScope, ev: WorkerGlobalScopeEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    reportError(e: any): void;
    setInterval(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
    setTimeout(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
    structuredClone<T>(value: T, options?: StructuredSerializeOptions): T;
}

Hierarchy

EventTarget
FontFaceSource
WindowOrWorkerGlobalScope
- WorkerGlobalScope (view full)

Properties

`Readonly`caches

caches: CacheStorage

Available only in secure contexts.

`Readonly`crossOriginIsolated

crossOriginIsolated: boolean

`Readonly`crypto

crypto: Crypto

`Readonly`fonts

fonts: FontFaceSet

`Readonly`indexedDB

indexedDB: IDBFactory

`Readonly`isSecureContext

isSecureContext: boolean

`Readonly`location

location: WorkerLocation

Returns workerGlobal's WorkerLocation object.

`Readonly`navigator

navigator: WorkerNavigator

Returns workerGlobal's WorkerNavigator object.

onerror

onerror: ((this: WorkerGlobalScope, ev: ErrorEvent) => any)

onlanguagechange

onlanguagechange: ((this: WorkerGlobalScope, ev: Event) => any)

onoffline

onoffline: ((this: WorkerGlobalScope, ev: Event) => any)

ononline

ononline: ((this: WorkerGlobalScope, ev: Event) => any)

onrejectionhandled

onrejectionhandled: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any)

onunhandledrejection

onunhandledrejection: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any)

`Readonly`origin

origin: string

`Readonly`performance

performance: Performance

`Readonly`self

self: WorkerGlobalScope & typeof globalThis

Returns workerGlobal.

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof WorkerGlobalScopeEventMap
Parameters
- type: K
- listener: ((this: WorkerGlobalScope, ev: WorkerGlobalScopeEventMap[K]) => any)
  - - (this, ev): any
    - Parameters
      this: WorkerGlobalScope
      ev: WorkerGlobalScopeEventMap[K]
      Returns any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
addEventListener(type, listener, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener

atob

atob(data): string
MDN Reference
Parameters
- data: string
Returns string
Inherited from WindowOrWorkerGlobalScope.atob

btoa

btoa(data): string
MDN Reference
Parameters
- data: string
Returns string
Inherited from WindowOrWorkerGlobalScope.btoa

clearInterval

clearInterval(id): void
MDN Reference
Parameters
- id: number
Returns void
Inherited from WindowOrWorkerGlobalScope.clearInterval

clearTimeout

clearTimeout(id): void
MDN Reference
Parameters
- id: number
Returns void
Inherited from WindowOrWorkerGlobalScope.clearTimeout

createImageBitmap

createImageBitmap(image, options?): Promise<ImageBitmap>
MDN Reference
Parameters
- image: ImageBitmapSource
- Optionaloptions: ImageBitmapOptions
Returns Promise<ImageBitmap>
Inherited from WindowOrWorkerGlobalScope.createImageBitmap
createImageBitmap(image, sx, sy, sw, sh, options?): Promise<ImageBitmap>
Parameters
- image: ImageBitmapSource
- sx: number
- sy: number
- sw: number
- sh: number
- Optionaloptions: ImageBitmapOptions
Returns Promise<ImageBitmap>
Inherited from WindowOrWorkerGlobalScope.createImageBitmap

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent

fetch

fetch(input, init?): Promise<Response>
MDN Reference
Parameters
- input: RequestInfo | URL
- Optionalinit: RequestInit
Returns Promise<Response>
Inherited from WindowOrWorkerGlobalScope.fetch

importScripts

importScripts(...urls): void
Fetches each URL in urls, executes them one-by-one in the order they are passed, and then returns (or throws if something went amiss).

MDN Reference
Parameters
- Rest...urls: (string | URL)[]
Returns void

queueMicrotask

queueMicrotask(callback): void
MDN Reference
Parameters
- callback: VoidFunction
Returns void
Inherited from WindowOrWorkerGlobalScope.queueMicrotask

removeEventListener

removeEventListener<K>(type, listener, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof WorkerGlobalScopeEventMap
Parameters
- type: K
- listener: ((this: WorkerGlobalScope, ev: WorkerGlobalScopeEventMap[K]) => any)
  - - (this, ev): any
    - Parameters
      this: WorkerGlobalScope
      ev: WorkerGlobalScopeEventMap[K]
      Returns any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
removeEventListener(type, listener, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener

reportError

reportError(e): void
MDN Reference
Parameters
- e: any
Returns void
Inherited from WindowOrWorkerGlobalScope.reportError

setInterval

setInterval(handler, timeout?, ...arguments): number
MDN Reference
Parameters
- handler: TimerHandler
- Optionaltimeout: number
- Rest...arguments: any[]
Returns number
Inherited from WindowOrWorkerGlobalScope.setInterval

setTimeout

setTimeout(handler, timeout?, ...arguments): number
MDN Reference
Parameters
- handler: TimerHandler
- Optionaltimeout: number
- Rest...arguments: any[]
Returns number
Inherited from WindowOrWorkerGlobalScope.setTimeout

structuredClone

structuredClone<T>(value, options?): T
MDN Reference
Type Parameters
- T = any
Parameters
- value: T
- Optionaloptions: StructuredSerializeOptions
Returns T
Inherited from WindowOrWorkerGlobalScope.structuredClone