//app/config/environment.js

ENV.serviceWorker = {
  enabled: true,
  serviceWorkerFile: "service-worker.js",
  excludePaths: ['tests/', 'online.html',],
  includePaths: ['/'],
  fallback: [
    '/online.html offline.html'      
  ],
  dynamicCache: [
    '/api/todos'
  ]
};

Upgrade your index.html (see below) and you are done. The service worker bootstrap logic will be added to your index.html automatically, using contentFor hooks.

Usage for Broccoli.js

npm install --save broccoli-serviceworker

Use broccoli-serviceworker as your last filter in the Brocfile.js like this

var writeServiceWorker = require('broccoli-serviceworker');

...

var completeTree = mergeTrees([appJs, appCss, publicFiles]);

module.exports = mergeTrees([completeTree, writeServiceWorker((completeTree)]);

Options

You can pass some options as the second argument to writeServiceWorker:


writeServiceWorker(completeTree, {
  serviceWorkerFile: "service-worker.js",
  excludePaths: ['tests/', 'online.html',],
  includePaths: ['/'],
  fallback: [
    '/online.html offline.html'      
  ],
  dynamicCache: [
    '/api/todos'
  ],
  skipWaiting: true
});

Files can be filtered using regular expressions.

{
  excludePaths: ['index.html', new RegExp(/.\.map$/)],
  includePaths: ['']
}

Upgrade your index.html

In order to use the generated serviceworker, you will need to register the serviceworker. This is done automatically if using as an Ember.js addon. If you're not using Ember.js, you can use the following code:

<!DOCTYPE html>
<html>
  ...
  <script>
    if ('serviceWorker' in navigator) {
      navigator.serviceWorker.register('./service-worker.js', {scope: './'})
          .catch(function(error) {
              alert('Error registering service worker:'+error);
          });
    } else {
        alert('service worker not supported');
    }      
  </script>
</html>

Keywords

FAQs

What is broccoli-serviceworker?

Is broccoli-serviceworker popular?

Is broccoli-serviceworker well maintained?

Package last updated on 23 Nov 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

broccoli-serviceworker