workbox-webpack-plugin

class GenerateSW

class GenerateSW {}

• This class supports creating a new, ready-to-use service worker file as part of the webpack compilation process.

  Use an instance of GenerateSW in the [plugins array](https://webpack.js.org/concepts/plugins/#usage) of a webpack config.

  // The following lists some common options; see the rest of the documentation
  // for the full set of options and defaults.
  new GenerateSW({
    exclude: [/.../, '...'],
    maximumFileSizeToCacheInBytes: ...,
    navigateFallback: '...',
    runtimeCaching: [{
      // Routing via a matchCallback function:
      urlPattern: ({request, url}) => ...,
      handler: '...',
      options: {
        cacheName: '...',
        expiration: {
          maxEntries: ...,
        },
      },
    }, {
      // Routing via a RegExp:
      urlPattern: new RegExp('...'),
      handler: '...',
      options: {
        cacheName: '...',
        plugins: [..., ...],
      },
    }],
    skipWaiting: ...,
  });

  module:workbox-webpack-plugin

class InjectManifest

class InjectManifest {}

• This class supports compiling a service worker file provided via swSrc, and injecting into that service worker a list of URLs and revision information for precaching based on the webpack asset pipeline.

  Use an instance of InjectManifest in the [plugins array](https://webpack.js.org/concepts/plugins/#usage) of a webpack config.

  In addition to injecting the manifest, this plugin will perform a compilation of the swSrc file, using the options from the main webpack configuration.

  // The following lists some common options; see the rest of the documentation
  // for the full set of options and defaults.
  new InjectManifest({
    exclude: [/.../, '...'],
    maximumFileSizeToCacheInBytes: ...,
    swSrc: '...',
  });

  module:workbox-webpack-plugin

interface GenerateSWConfig

interface GenerateSWConfig extends WebpackGenerateSWOptions {}