Interface DedicatedWorkerGlobalScope
caches: CacheStorage;
crossOriginIsolated: boolean;
crypto: Crypto;
fonts: FontFaceSet;
indexedDB: IDBFactory;
isSecureContext: boolean;
location: WorkerLocation;
name: string;
navigator: WorkerNavigator;
onerror: ((this: WorkerGlobalScope, ev: ErrorEvent) => any);
onlanguagechange: ((this: WorkerGlobalScope, ev: Event) => any);
onmessage: ((this: DedicatedWorkerGlobalScope, ev: MessageEvent<any>) => any);
onmessageerror: ((this: DedicatedWorkerGlobalScope, ev: MessageEvent<any>) => any);
onoffline: ((this: WorkerGlobalScope, ev: Event) => any);
ononline: ((this: WorkerGlobalScope, ev: Event) => any);
onrejectionhandled: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any);
onrtctransform: ((this: DedicatedWorkerGlobalScope, ev: Event) => any);
onunhandledrejection: ((this: WorkerGlobalScope, ev: PromiseRejectionEvent) => any);
origin: string;
performance: Performance;
self: WorkerGlobalScope & typeof globalThis;
addEventListener<K>(type: K, listener: ((this: DedicatedWorkerGlobalScope, ev: DedicatedWorkerGlobalScopeEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
atob(data: string): string;
btoa(data: string): string;
cancelAnimationFrame(handle: number): void;
clearInterval(id: number): void;
clearTimeout(id: number): void;
close(): 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;
postMessage(message: any, transfer: Transferable[]): void;
postMessage(message: any, options?: StructuredSerializeOptions): void;
queueMicrotask(callback: VoidFunction): void;
removeEventListener<K>(type: K, listener: ((this: DedicatedWorkerGlobalScope, ev: DedicatedWorkerGlobalScopeEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
reportError(e: any): void;
requestAnimationFrame(callback: FrameRequestCallback): number;
setInterval(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
setTimeout(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
structuredClone<T>(value: T, options?: StructuredSerializeOptions): T;
}
Hierarchy
- WorkerGlobalScope
- AnimationFrameProvider
- DedicatedWorkerGlobalScope (view full)
Index
Properties
Methods
Properties
Readonlycaches
Available only in secure contexts.
ReadonlycrossOriginIsolated
Readonlycrypto
Readonlyfonts
ReadonlyindexedDB
ReadonlyisSecureContext
Readonlylocation
Returns workerGlobal's WorkerLocation object.
Readonlyname
Returns dedicatedWorkerGlobal's name, i.e. the value given to the Worker constructor. Primarily useful for debugging.
Readonlynavigator
Returns workerGlobal's WorkerNavigator object.
onerror
onlanguagechange
onmessage
onmessageerror
onoffline
ononline
onrejectionhandled
onrtctransform
onunhandledrejection
Readonlyorigin
Readonlyperformance
Readonlyself
Returns workerGlobal.
Methods
addEventListener
- add
Event <K>(type, listener, options?): voidListener 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.
Type Parameters
- K extends keyof DedicatedWorkerGlobalScopeEventMap
Parameters
- type: K
- listener: ((this: DedicatedWorkerGlobalScope, ev: DedicatedWorkerGlobalScopeEventMap[K]) => any)
- (this, ev): any
Parameters
Returns any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- add
Event (type, listener, options?): voidListener 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.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
atob
btoa
cancelAnimationFrame
clearInterval
clearTimeout
close
createImageBitmap
- create
Image (image, options?): Promise<ImageBitmap>Bitmap Parameters
- image: ImageBitmapSource
Optionaloptions: ImageBitmapOptions
Returns Promise<ImageBitmap>
- create
Image (image, sx, sy, sw, sh, options?): Promise<ImageBitmap>Bitmap Parameters
- image: ImageBitmapSource
- sx: number
- sy: number
- sw: number
- sh: number
Optionaloptions: ImageBitmapOptions
Returns Promise<ImageBitmap>
dispatchEvent
- dispatch
Event (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.
Parameters
- event: Event
Returns boolean
fetch
- fetch(input, init?): Promise<Response>
Parameters
- input: RequestInfo | URL
Optionalinit: RequestInit
Returns Promise<Response>
importScripts
- import
Scripts (...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).
Parameters
Rest...urls: (string | URL)[]
Returns void
postMessage
- post
Message (message, transfer): void Clones message and transmits it to the Worker object associated with dedicatedWorkerGlobal. transfer can be passed as a list of objects that are to be transferred rather than cloned.
Parameters
- message: any
- transfer: Transferable[]
Returns void
- post
Message (message, options?): void Parameters
- message: any
Optionaloptions: StructuredSerializeOptions
Returns void
queueMicrotask
- queue
Microtask (callback): void Parameters
- callback: VoidFunction
Returns void
removeEventListener
- remove
Event <K>(type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof DedicatedWorkerGlobalScopeEventMap
Parameters
- type: K
- listener: ((this: DedicatedWorkerGlobalScope, ev: DedicatedWorkerGlobalScopeEventMap[K]) => any)
- (this, ev): any
Parameters
Returns any
Optionaloptions: boolean | EventListenerOptions
Returns void
- remove
Event (type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
reportError
requestAnimationFrame
- request
Animation (callback): numberFrame Parameters
- callback: FrameRequestCallback
Returns number
setInterval
- set
Interval (handler, timeout?, ...arguments): number Parameters
- handler: TimerHandler
Optionaltimeout: numberRest...arguments: any[]
Returns number
setTimeout
- set
Timeout (handler, timeout?, ...arguments): number Parameters
- handler: TimerHandler
Optionaltimeout: numberRest...arguments: any[]
Returns number
structuredClone
- structured
Clone <T>(value, options?): T Type Parameters
Parameters
- value: T
Optionaloptions: StructuredSerializeOptions
Returns T
(the Worker global scope) is accessible through the self keyword. Some additional global functions, namespaces objects, and constructors, not typically associated with the worker global scope, but available on it, are listed in the JavaScript Reference. See also: Functions available to workers.
MDN Reference