Need help with serviceworker-webpack-plugin?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

454 Stars 74 Forks MIT License 77 Commits 26 Opened issues


Simplifies creation of a service worker to serve your webpack bundles. :recycle:

Services available


Need anything else?

Contributors list


Simplifies creation of a service worker to serve your webpack bundles.

npm version npm downloads Build Status

Dependencies DevDependencies


npm install serviceworker-webpack-plugin

The problem solved

When building a service worker, you probably want to cache all your assets during the

phase. But in order to do so, you need their names. That's not simple when you are using Webpack: - The assets names are non-deterministic when taking advantage of the long term caching. - The assets list can even evolve over time as you add splitting points or more resources. - You want to be able to use your service worker with the dev-server mode of Webpack. - You want to keep the build process as simple as possible.


1. Add the plugin to your webpack config

import ServiceWorkerWebpackPlugin from 'serviceworker-webpack-plugin';


plugins: [ new ServiceWorkerWebpackPlugin({ entry: path.join(__dirname, 'src/sw.js'), }), ],

2. Register the service worker in your main JS thread

import runtime from 'serviceworker-webpack-plugin/lib/runtime';

if ('serviceWorker' in navigator) { const registration = runtime.register(); }

3. Write your own

You can now use the global

variable in your
. E.g. In our example this object looks like:
  assets: [

Simple example

You can have a look at the

folder if you need a full working example.



  • options
    • entry
      , required, string: Path to the actual service worker implementation.
    • filename
      , string, default
      : Relative (from the webpack's config
      ) output path for emitted script.
    • excludes
      , array, default
      ['**/.*', '**/*.map']
      : Exclude matched assets from being added to the
      variable. (Blacklist)
    • includes
      , array, default
      : Include matched assets added to the
      variable. (Whitelist)
    • publicPath
      , string, default
      : Specifies the public URL address of the output files when referenced in a browser. We use this value to load the service worker over the network.
    • template
      , function, default noop: This callback function can be used to inject statically generated service worker. It's taking a
      argument and must return a promise.
  • transformOptions
    , function: This callback function receives a raw
    argument. The
    key contains all the webpack build information.
  • minimize
    : Whether to minimize output. Defaults to
    process.env.NODE_ENV === 'production'



Why simply not use the

I wouldn't have been able to write this plugin without the offline-plugin project. Thanks @NekR for sharing it!

Still, soon after using it, I realized that it wasn't what I was looking for. - The abstraction provided was too high. (I needed to build some custom fetch logic.) - It was making me, even more, dependent on Webpack. (What if later, I want to switch to another build system?)

Hence, I decided to change the approach and created this thin layer on top of Webpack to solve the assets name issue. Nothing more.

If you don't care about my two issues with

then you don't need to use this package,
is great.

The specs



We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.