Skip to content

Commit b2bbc9d

Browse files
japgollyjapgolly
authored
Merge pull request #704 from scala-js/feature/service-worker-registration-options
Add `ServiceWorkerRegistrationOptions`
2 parents f935251 + 60b9798 commit b2bbc9d

File tree

6 files changed

+79
-3
lines changed

6 files changed

+79
-3
lines changed

‎api-reports/2_12.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24452,7 +24452,7 @@ ServiceWorkerContainer[JT] def getRegistrations(): js.Promise[js.Array[ServiceWo
2445224452
ServiceWorkerContainer[JT] var oncontrollerchange: js.Function1[Event, _]
2445324453
ServiceWorkerContainer[JT] var onmessage: js.Function1[MessageEvent, _]
2445424454
ServiceWorkerContainer[JT] def ready: js.Promise[ServiceWorkerRegistration]
24455-
ServiceWorkerContainer[JT] def register(scriptURL: String, options: js.Object?): js.Promise[ServiceWorkerRegistration]
24455+
ServiceWorkerContainer[JT] def register(scriptURL: String, options: ServiceWorkerRegistrationOptions?): js.Promise[ServiceWorkerRegistration]
2445624456
ServiceWorkerContainer[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
2445724457
ServiceWorkerContainer[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
2445824458
ServiceWorkerGlobalScope[JO] def self: ServiceWorkerGlobalScope
@@ -24520,12 +24520,19 @@ ServiceWorkerRegistration[JT] def showNotification(title: String, options: Notif
2452024520
ServiceWorkerRegistration[JT] def unregister(): js.Promise[Boolean]
2452124521
ServiceWorkerRegistration[JT] def update(): js.Promise[Unit]
2452224522
ServiceWorkerRegistration[JT] var waiting: ServiceWorker
24523+
ServiceWorkerRegistrationOptions[JT] var scope: js.UndefOr[String]
24524+
ServiceWorkerRegistrationOptions[JT] var `type`: js.UndefOr[WorkerType]
24525+
ServiceWorkerRegistrationOptions[JT] var updateViaCache: js.UndefOr[ServiceWorkerUpdateViaCache]
2452324526
ServiceWorkerState[JT]
2452424527
ServiceWorkerState[SO] val activated: ServiceWorkerState
2452524528
ServiceWorkerState[SO] val activating: ServiceWorkerState
2452624529
ServiceWorkerState[SO] val installed: ServiceWorkerState
2452724530
ServiceWorkerState[SO] val installing: ServiceWorkerState
2452824531
ServiceWorkerState[SO] val redundant: ServiceWorkerState
24532+
ServiceWorkerUpdateViaCache[JT]
24533+
ServiceWorkerUpdateViaCache[SO] val all: ServiceWorkerUpdateViaCache
24534+
ServiceWorkerUpdateViaCache[SO] val imports: ServiceWorkerUpdateViaCache
24535+
ServiceWorkerUpdateViaCache[SO] val none: ServiceWorkerUpdateViaCache
2452924536
ShadowRoot[JC] def activeElement: Element
2453024537
ShadowRoot[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
2453124538
ShadowRoot[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit

‎api-reports/2_13.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24452,7 +24452,7 @@ ServiceWorkerContainer[JT] def getRegistrations(): js.Promise[js.Array[ServiceWo
2445224452
ServiceWorkerContainer[JT] var oncontrollerchange: js.Function1[Event, _]
2445324453
ServiceWorkerContainer[JT] var onmessage: js.Function1[MessageEvent, _]
2445424454
ServiceWorkerContainer[JT] def ready: js.Promise[ServiceWorkerRegistration]
24455-
ServiceWorkerContainer[JT] def register(scriptURL: String, options: js.Object?): js.Promise[ServiceWorkerRegistration]
24455+
ServiceWorkerContainer[JT] def register(scriptURL: String, options: ServiceWorkerRegistrationOptions?): js.Promise[ServiceWorkerRegistration]
2445624456
ServiceWorkerContainer[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
2445724457
ServiceWorkerContainer[JT] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
2445824458
ServiceWorkerGlobalScope[JO] def self: ServiceWorkerGlobalScope
@@ -24520,12 +24520,19 @@ ServiceWorkerRegistration[JT] def showNotification(title: String, options: Notif
2452024520
ServiceWorkerRegistration[JT] def unregister(): js.Promise[Boolean]
2452124521
ServiceWorkerRegistration[JT] def update(): js.Promise[Unit]
2452224522
ServiceWorkerRegistration[JT] var waiting: ServiceWorker
24523+
ServiceWorkerRegistrationOptions[JT] var scope: js.UndefOr[String]
24524+
ServiceWorkerRegistrationOptions[JT] var `type`: js.UndefOr[WorkerType]
24525+
ServiceWorkerRegistrationOptions[JT] var updateViaCache: js.UndefOr[ServiceWorkerUpdateViaCache]
2452324526
ServiceWorkerState[JT]
2452424527
ServiceWorkerState[SO] val activated: ServiceWorkerState
2452524528
ServiceWorkerState[SO] val activating: ServiceWorkerState
2452624529
ServiceWorkerState[SO] val installed: ServiceWorkerState
2452724530
ServiceWorkerState[SO] val installing: ServiceWorkerState
2452824531
ServiceWorkerState[SO] val redundant: ServiceWorkerState
24532+
ServiceWorkerUpdateViaCache[JT]
24533+
ServiceWorkerUpdateViaCache[SO] val all: ServiceWorkerUpdateViaCache
24534+
ServiceWorkerUpdateViaCache[SO] val imports: ServiceWorkerUpdateViaCache
24535+
ServiceWorkerUpdateViaCache[SO] val none: ServiceWorkerUpdateViaCache
2452924536
ShadowRoot[JC] def activeElement: Element
2453024537
ShadowRoot[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
2453124538
ShadowRoot[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit

‎dom/src/main/scala-2/org/scalajs/dom/ServiceWorkerUpdateViaCache.scala

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
sealed trait ServiceWorkerUpdateViaCache extends js.Any
7+
8+
object ServiceWorkerUpdateViaCache {
9+
/** The service worker script and all of its imports will be updated. */
10+
val all: ServiceWorkerUpdateViaCache = "all".asInstanceOf[ServiceWorkerUpdateViaCache]
11+
12+
/** Only imports referenced by the service worker script will be updated. This is the default. */
13+
val imports: ServiceWorkerUpdateViaCache = "imports".asInstanceOf[ServiceWorkerUpdateViaCache]
14+
15+
/** Neither the service worker, nor its imports will be updated. */
16+
val none: ServiceWorkerUpdateViaCache = "none".asInstanceOf[ServiceWorkerUpdateViaCache]
17+
}

‎dom/src/main/scala-3/org/scalajs/dom/ServiceWorkerUpdateViaCache.scala

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
opaque type ServiceWorkerUpdateViaCache <: String = String
6+
7+
object ServiceWorkerUpdateViaCache {
8+
/** The service worker script and all of its imports will be updated. */
9+
val all: ServiceWorkerUpdateViaCache = "all"
10+
11+
/** Only imports referenced by the service worker script will be updated. This is the default. */
12+
val imports: ServiceWorkerUpdateViaCache = "imports"
13+
14+
/** Neither the service worker, nor its imports will be updated. */
15+
val none: ServiceWorkerUpdateViaCache = "none"
16+
}

‎dom/src/main/scala/org/scalajs/dom/ServiceWorkerContainer.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ trait ServiceWorkerContainer extends EventTarget {
1414
* method can't return a ServiceWorkerRegistration, it returns a Promise. You can call this method unconditionally
1515
* from the controlled page, i.e., you don't need to first check whether there's an active registration.
1616
*/
17-
def register(scriptURL: String, options: js.Object = js.native): js.Promise[ServiceWorkerRegistration] = js.native
17+
def register(scriptURL: String,
18+
options: ServiceWorkerRegistrationOptions = js.native): js.Promise[ServiceWorkerRegistration] = js.native
1819

1920
/** The ServiceWorkerContainer.controller read-only property of the ServiceWorkerContainer interface returns the
2021
* ServiceWorker whose state is activated (the same object returned by ServiceWorkerRegistration.active). This

‎dom/src/main/scala/org/scalajs/dom/ServiceWorkerRegistrationOptions.scala

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/** All documentation for facades is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API
2+
* and available under the Creative Commons Attribution-ShareAlike v2.5 or later.
3+
* http://creativecommons.org/licenses/by-sa/2.5/
4+
*
5+
* Everything else is under the MIT License http://opensource.org/licenses/MIT
6+
*/
7+
package org.scalajs.dom
8+
9+
import scala.scalajs.js
10+
11+
/** An object containing registration options. */
12+
trait ServiceWorkerRegistrationOptions extends js.Object {
13+
14+
/** A string representing a URL that defines a service worker's registration scope; that is, what range of URLs a
15+
* service worker can control. This is usually a relative URL. It is relative to the base URL of the application. By
16+
* default, the `scope` value for a service worker registration is set to the directory where the service worker
17+
* script is located.
18+
*/
19+
var scope: js.UndefOr[String] = js.undefined
20+
21+
/** A string specifying the type of worker to create. */
22+
var `type`: js.UndefOr[WorkerType] = js.undefined
23+
24+
/** A string indicating how much of a service worker's resources will be updated when a call is made to
25+
* `ServiceWorkerRegistration.updateViaCache`.
26+
*/
27+
var updateViaCache: js.UndefOr[ServiceWorkerUpdateViaCache] = js.undefined
28+
}

0 commit comments

Comments
 (0)