[TalAter#30] Allow overriding default scope of ServiceWorker

cspiker · Aug 29, 2018 · eefaed6 · eefaed6
1 parent fe59134
commit eefaed6
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/dist/upup.min.js b/dist/upup.min.js
diff --git a/dist/upup.min.js.map b/dist/upup.min.js.map
diff --git a/dist/upup.zip b/dist/upup.zip
diff --git a/docs/README.md b/docs/README.md
@@ -99,6 +99,7 @@ The settings object supports the following options:
 - `cache-version`      (String|Number) Optional version number, change this when offline files change. UpUp will download and cache all content-url and assets files again
 - `service-worker-url` (String)  The url to the service worker file (`upup.sw.min.js`)
                                  Allows loading `upup.min.js` from a CDN while `upup.sw.min.js` stays local (see [scope](https://github.com/TalAter/UpUp/blob/master/docs/README.md#scope))
+- `registration-options` (Object) An object containing registration options for ServiceWorkerContainer.register().
 
 # API Reference
 

diff --git a/src/upup.js b/src/upup.js
@@ -105,6 +105,7 @@
    * - `cache-version`      (String|Number) Optional version number, change this when offline files change. UpUp will download and cache all content-url and assets files again
    * - `service-worker-url` (String)  The url to the service worker file (`upup.sw.min.js`)
    *                                  Allows loading `upup.min.js` from a CDN while `upup.sw.min.js` stays local (see [scope](https://github.com/TalAter/UpUp/blob/master/docs/README.md#scope))
+   * - `registration-options` (Object) An object containing registration options for ServiceWorkerContainer.register().
    *
    * # API Reference
    */
@@ -125,7 +126,8 @@
 
   // Settings live here, and these are their defaults
   var _settings = {
-    'service-worker-url': 'upup.sw.min.js'
+    'service-worker-url': 'upup.sw.min.js',
+    'registration-options': {scope: './'}
   };
 
   var _debugState = false;
@@ -156,7 +158,7 @@
       this.addSettings(settings);
 
       // register the service worker
-      _serviceWorker.register(_settings['service-worker-url'], {scope: './'}).then(function(registration) {
+      _serviceWorker.register(_settings['service-worker-url'], _settings['registration-options']).then(function(registration) {
         // Registration was successful
         if (_debugState) {
           console.log('Service worker registration successful with scope: %c'+registration.scope, _debugStyle);
@@ -203,7 +205,7 @@
       }
 
       // add new settings to our settings object
-      ['content', 'content-url', 'assets', 'service-worker-url', 'cache-version'].forEach(function(settingName) {
+      ['content', 'content-url', 'assets', 'service-worker-url', 'cache-version', 'registration-options'].forEach(function(settingName) {
         if (settings[settingName] !== undefined) {
           _settings[settingName] = settings[settingName];
         }