class ServiceWorkerGlobalScope

package js.html

extends WorkerGlobalScope › EventTarget

Available on HTML5

The ServiceWorkerGlobalScope interface of the ServiceWorker API represents the global execution context of a service worker.

Documentation ServiceWorkerGlobalScope by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope

Variables

read onlyclients:Clients

Contains the Clients object associated with the service worker.

onactivate:Function

An event handler fired whenever an activate event occurs — when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.active worker.

onfetch:Function

An event handler fired whenever a fetch event occurs — when a GlobalFetch.fetch is called.

oninstall:Function

An event handler fired whenever an install event occurs — when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.

onmessage:Function

An event handler fired whenever a message event occurs — when incoming messages are received. Controlled pages can use the MessagePort.postMessage() method to send messages to service workers. The service worker can optionally send a response back via the MessagePort exposed in event.data.port, corresponding to the controlled page.

onnotificationclick:Function

An event handler fired whenever a notificationclick event occurs — when a user clicks on a displayed notification.

onpush:Function

An event handler fired whenever a push event occurs — when a server push notification is received.

onpushsubscriptionchange:Function

An event handler fired whenever a pushsubscriptionchange event occurs — when a push subscription has been invalidated, or is about to be invalidated (e.g. when a push service sets an expiration time.)

read onlyregistration:ServiceWorkerRegistration

Contains the ServiceWorkerRegistration object that represents the service worker's registration.

Methods

skipWaiting ():Promise<Void>

Throws:

null

DOMError

Inherited Variables

Defined by WorkerGlobalScope

read onlyconsole:Console

Returns the Console associated with the worker.

read onlyindexedDB:Factory

read onlylocation:WorkerLocation

Returns the WorkerLocation associated with the worker. It is a specific location object, mostly a subset of the Location for browsing scopes, but adapted to workers.

read onlynavigator:WorkerNavigator

Returns the WorkerNavigator associated with the worker. It is a specific navigator object, mostly a subset of the Navigator for browsing scopes, but adapted to workers.

onclose:Function

Is an EventHandler representing the code to be called when the close event is raised.

onerror:EitherType<Event, String> ‑> String ‑> Int ‑> Int ‑> Dynamic ‑> Bool

Is an EventHandler representing the code to be called when the error event is raised.

onoffline:Function

Is an EventHandler representing the code to be called when the offline event is raised.

ononline:Function

Is an EventHandler representing the code to be called when the online event is raised.

read onlyperformance:Performance

Returns the Performance associated with the worker. It is a regular performance object, except that only a subset of its property and methods are available to workers.

read onlyself:WorkerGlobalScope

Returns a reference to the WorkerGlobalScope itself. Most of the time it is a specific scope like DedicatedWorkerGlobalScope,  SharedWorkerGlobalScope or ServiceWorkerGlobalScope.

Inherited Methods

Defined by WorkerGlobalScope

atob (atob:String):String

Throws:

null

DOMError

btoa (btoa:String):String

Throws:

null

DOMError

clearInterval (handle:Int = 0):Void

clearTimeout (handle:Int = 0):Void

close ():Void

Throws:

null

DOMError

createImageBitmap (aImage:EitherType<ImageElement, EitherType<VideoElement, EitherType<CanvasElement, EitherType<Blob, EitherType<ImageData, EitherType<CanvasRenderingContext2D, ImageBitmap>>>>>>, aSx:Int, aSy:Int, aSw:Int, aSh:Int):Promise<ImageBitmap>

createImageBitmap (aImage:EitherType<ImageElement, EitherType<VideoElement, EitherType<CanvasElement, EitherType<Blob, EitherType<ImageData, EitherType<CanvasRenderingContext2D, ImageBitmap>>>>>>):Promise<ImageBitmap>

Throws:

null

DOMError

dump (?str:String):Void

Allows you to write a message to stdout — i.e. in your terminal. This is the same as Firefox's window.dump, but for workers.

fetch (input:EitherType<Request, String>, ?init:RequestInit):Promise<Response>

Throws:

null

DOMError

importScripts (urls:Rest<String>):Void

Throws:

null

DOMError

setInterval (handler:String, ?timeout:Int, unused:Rest<Dynamic>):Int

setInterval (handler:Function, ?timeout:Int, arguments:Rest<Dynamic>):Int

Throws:

null

DOMError

setTimeout (handler:String, timeout:Int = 0, unused:Rest<Dynamic>):Int

setTimeout (handler:Function, timeout:Int = 0, arguments:Rest<Dynamic>):Int

Throws:

null

DOMError

Defined by EventTarget

addEventListener (type:String, listener:Function, capture:Bool = false):Void

addEventListener (type:String, listener:EventListener, capture:Bool = false, ?wantsUntrusted:Bool):Void

Throws:

null

DOMError

dispatchEvent (event:Event):Bool

Throws:

null

DOMError

removeEventListener (type:String, listener:Function, capture:Bool = false):Void

removeEventListener (type:String, listener:EventListener, capture:Bool = false):Void

Throws:

null

DOMError