org.scalajs.dom.experimental.serviceworkers
ServiceWorkerGlobalScope
Companion object ServiceWorkerGlobalScope
trait ServiceWorkerGlobalScope extends raw.EventTarget with WorkerGlobalScope
The ServiceWorkerGlobalScope interface of the ServiceWorker API represents the global execution context of a service worker.
Developers should keep in mind that the ServiceWorker.state is not persisted across the termination/restart cycle, so each event handler should assume it's being invoked with a bare, default global state.
Once successfully registered, a service worker can and will be terminated when idle to conserve memory and processor power. An active service worker is automatically restarted to respond to events, such as ServiceWorkerGlobalScope.onfetch or ServiceWorkerGlobalScope.onmessage.
Additionally, synchronous requests are not allowed from within a service worker — only asynchronous requests, like those initiated via the fetch() method, can be used.
MDN
- Annotations
- @JSType() @native()
- Alphabetic
- By Inheritance
- ServiceWorkerGlobalScope
- WorkerGlobalScope
- WindowOrWorkerGlobalScope
- WindowTimers
- WindowBase64
- EventTarget
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addEventListener[T <: raw.Event](type: String, listener: Function1[T, _], options: EventListenerOptions): Unit
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
This implementation accepts a settings object of type EventListenerOptions.
MDN
- Definition Classes
- EventTarget
- def addEventListener[T <: raw.Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
MDN
- Definition Classes
- EventTarget
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def atob(encodedString: String): String
Decodes a string of data which has been encoded using base-64 encoding.
Decodes a string of data which has been encoded using base-64 encoding.
- Definition Classes
- WindowBase64
- def btoa(rawString: String): String
Creates a base-64 encoded ASCII string from a "string" of binary data.
Creates a base-64 encoded ASCII string from a "string" of binary data.
- Definition Classes
- WindowBase64
- def caches: UndefOr[cachestorage.CacheStorage]
Returns the CacheStorage object associated with the current context.
Returns the CacheStorage object associated with the current context. This object enables functionality such as storing assets for offline use, and generating custom responses to requests.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def clearInterval(handle: Int): Unit
Cancels repeated action which was set up using setInterval.
Cancels repeated action which was set up using setInterval.
MDN
- Definition Classes
- WindowTimers
- def clearTimeout(handle: Int): Unit
Clears the delay set by window.setTimeout().
Clears the delay set by window.setTimeout().
MDN
- Definition Classes
- WindowTimers
- def clients: Clients
Returns the Clients object associated with the service worker.
Returns the Clients object associated with the service worker.
MDN
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def close(): Unit
The close() method of the WorkerGlobalScope interface discards any tasks queued in the WorkerGlobalScope's event loop, effectively closing this particular scope.
The close() method of the WorkerGlobalScope interface discards any tasks queued in the WorkerGlobalScope's event loop, effectively closing this particular scope.
MDN
- Definition Classes
- WorkerGlobalScope
- def createImageBitmap(image: CreateImageBitmapInput, sx: Double, sy: Double, sw: Double, sh: Double, options: CreateImageBitmapOptions): Promise[ImageBitmap]
- Definition Classes
- WindowOrWorkerGlobalScope
- def createImageBitmap(image: CreateImageBitmapInput, sx: Double, sy: Double, sw: Double, sh: Double): Promise[ImageBitmap]
- Definition Classes
- WindowOrWorkerGlobalScope
- def createImageBitmap(image: CreateImageBitmapInput, options: CreateImageBitmapOptions): Promise[ImageBitmap]
- Definition Classes
- WindowOrWorkerGlobalScope
- def createImageBitmap(image: CreateImageBitmapInput): Promise[ImageBitmap]
Accepts a variety of different image sources, and returns a Promise which resolves to an ImageBitmap.
Accepts a variety of different image sources, and returns a Promise which resolves to an ImageBitmap. Optionally the source is cropped to the rectangle of pixels originating at (sx, sy) with width sw, and height sh.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def crossOriginIsolated: Boolean
Returns a boolean value that indicates whether a SharedArrayBuffer can be sent via a Window.postMessage() call.
Returns a boolean value that indicates whether a SharedArrayBuffer can be sent via a Window.postMessage() call.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def dispatchEvent(evt: raw.Event): Boolean
Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order.
Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().
MDN
- Definition Classes
- EventTarget
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fetch(info: RequestInfo, init: RequestInit = null): Promise[Response]
Starts the process of fetching a resource from the network.
Starts the process of fetching a resource from the network.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def importScripts(urls: Array[String]): Unit
The importScripts() method of the WorkerGlobalScope interface imports one or more scripts into the worker's scope.
The importScripts() method of the WorkerGlobalScope interface imports one or more scripts into the worker's scope.
MDN
- Definition Classes
- WorkerGlobalScope
- def indexedDB: UndefOr[IDBFactory]
Provides a mechanism for applications to asynchronously access capabilities of indexed databases.
Provides a mechanism for applications to asynchronously access capabilities of indexed databases.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- def isSecureContext: Boolean
Returns a boolean indicating whether the current context is secure or not.
Returns a boolean indicating whether the current context is secure or not.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def location: WorkerLocation
The location read-only property of the WorkerGlobalScope interface returns the WorkerLocation associated with the worker.
The location read-only property of the WorkerGlobalScope interface 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.
MDN
- Definition Classes
- WorkerGlobalScope
- def navigator: WorkerNavigator
The navigator read-only property of the WorkerGlobalScope interface returns the WorkerNavigator associated with the worker.
The navigator read-only property of the WorkerGlobalScope interface 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.
MDN
- Definition Classes
- WorkerGlobalScope
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val onError: Function1[raw.ErrorEvent, _]
The onerror property of the WorkerGlobalScope interface represents an EventHandler to be called when the error event occurs and bubbles through the Worker.
The onerror property of the WorkerGlobalScope interface represents an EventHandler to be called when the error event occurs and bubbles through the Worker.
MDN
- Definition Classes
- WorkerGlobalScope
- val onactivate: Function1[ExtendableEvent, _]
An event handler fired whenever an activate event occurs (when the service worker activates).
An event handler fired whenever an activate event occurs (when the service worker activates). This happens after installation, when the page to be controlled by the service worker refreshes.
MDN
- val onfetch: Function1[FetchEvent, _]
An event handler fired whenever a fetch event occurs — when a fetch() is called.
An event handler fired whenever a fetch event occurs — when a fetch() is called.
MDN
- val oninstall: Function1[ExtendableEvent, _]
An event handler fired whenever an install event occurs — when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.
An event handler fired whenever an install event occurs — when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.
MDN
- val onlanguagechange: Function1[raw.Event, _]
The onlanguagechange property of the WorkerGlobalScope interface represents an EventHandler to be called when the languagechange event occurs and bubbles through the Worker.
The onlanguagechange property of the WorkerGlobalScope interface represents an EventHandler to be called when the languagechange event occurs and bubbles through the Worker.
MDN
- Definition Classes
- WorkerGlobalScope
- val onmessage: Function1[MessageEvent, _]
An event handler fired whenever a message event occurs — when incoming messages are received.
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.
MDN
- val onoffline: Function1[raw.Event, _]
The onoffline property of the WorkerGlobalScope interface represents an EventHandler to be called when the offline event occurs and bubbles through the Worker.
The onoffline property of the WorkerGlobalScope interface represents an EventHandler to be called when the offline event occurs and bubbles through the Worker.
MDN
- Definition Classes
- WorkerGlobalScope
- val ononline: Function1[raw.Event, _]
The ononline property of the WorkerGlobalScope interface represents an EventHandler to be called when the online event occurs and bubbles through the Worker.
The ononline property of the WorkerGlobalScope interface represents an EventHandler to be called when the online event occurs and bubbles through the Worker.
MDN
- Definition Classes
- WorkerGlobalScope
- def origin: String
Returns the origin of the global scope, serialized as a string.
Returns the origin of the global scope, serialized as a string.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def queueMicrotask(function: Function0[Any]): Unit
Enqueues a microtask—a short function to be executed after execution of the JavaScript code completes and control isn't being returned to a JavaScript caller, but before handling callbacks and other tasks.
Enqueues a microtask—a short function to be executed after execution of the JavaScript code completes and control isn't being returned to a JavaScript caller, but before handling callbacks and other tasks.
This lets your code run without interfering with other, possibly higher priority, code, but before the browser runtime regains control, potentially depending upon the work you need to complete.
MDN
- Definition Classes
- WindowOrWorkerGlobalScope
- def registration: ServiceWorkerRegistration
The registration read-only property of the ServiceWorkerGlobalScope interface returns a reference to the ServiceWorkerRegistration object, which represents the service worker's registration.
- def removeEventListener[T <: raw.Event](type: String, listener: Function1[T, _], options: EventListenerOptions): Unit
Removes the event listener previously registered with EventTarget.addEventListener.
Removes the event listener previously registered with EventTarget.addEventListener.
This implementation accepts a settings object of type EventListenerOptions.
MDN
- Definition Classes
- EventTarget
- def removeEventListener[T <: raw.Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit
Removes the event listener previously registered with EventTarget.addEventListener.
Removes the event listener previously registered with EventTarget.addEventListener.
MDN
- Definition Classes
- EventTarget
- def self: ServiceWorkerGlobalScope.this.type
The self read-only property of the WorkerGlobalScope interface returns a reference to the WorkerGlobalScope itself.
The self read-only property of the WorkerGlobalScope interface returns a reference to the WorkerGlobalScope itself. Most of the time it is a specific scope like DedicatedWorkerGlobalScope, SharedWorkerGlobalScope, or ServiceWorkerGlobalScope.
MDN
- Definition Classes
- WorkerGlobalScope
- def setInterval(handler: Function0[Any], timeout: Double): Int
Calls a function or executes a code snippet repeatedly, with a fixed time delay between each call to that function.
Calls a function or executes a code snippet repeatedly, with a fixed time delay between each call to that function.
MDN
- Definition Classes
- WindowTimers
- def setTimeout(handler: Function0[Any], timeout: Double): Int
Calls a function or executes a code snippet after a specified delay.
Calls a function or executes a code snippet after a specified delay.
MDN
- Definition Classes
- WindowTimers
- def skipWaiting(): Promise[Unit]
Forces the waiting service worker to become the active service worker.
Forces the waiting service worker to become the active service worker. This method can be used with Clients.claim to ensure that updates to the underlying service worker take effect immediately for both the current client and all other active clients.
MDN
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def valueOf(): Any
- Definition Classes
- Object
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()