@neutrinojs/pwa v8.3.0

Neutrino PWA Middleware

@neutrinojs/pwa is Neutrino middleware for augmenting a Neutrino web application with Progressive Web Application capabilities. This middleware is usually only added during production builds.

Requirements

• Node.js ^8.10 or 10+
• Yarn v1.2.1+, or npm v5.4+
• Neutrino 9
• webpack 4

Installation

@neutrinojs/pwa can be installed via the Yarn or npm clients.

Yarn

❯ yarn add --dev @neutrinojs/pwa

npm

❯ npm install --save-dev @neutrinojs/pwa

Usage

@neutrinojs/pwa can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

// Using function middleware format
const pwa = require('@neutrinojs/pwa');

// Use with default options
neutrino.use(pwa);

// Usage showing overriding options
neutrino.use(pwa, {
  ServiceWorker: {
    events: true
  },
  relativePaths: false,
  excludes: ['_redirects'],
  cacheMaps: [{ match: /.*/, to: '/', requestTypes: ['navigate'] }],
  publicPath: '/',
  // Override pluginId to add an additional pwa plugin instance
  pluginId: 'pwa'
});

// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['@neutrinojs/pwa']
};

// Usage showing overriding options
module.exports = {
  use: [
    ['@neutrinojs/pwa', {
      ServiceWorker: {
        events: true
      },
      relativePaths: false,
      excludes: ['_redirects'],
      cacheMaps: [{ match: /.*/, to: '/', requestTypes: ['navigate'] }],
      publicPath: '/',
      // Override pluginId to add an additional pwa plugin instance
      pluginId: 'pwa'
    }]
  ]
};

The options passed to the PWA middleware are options accepted by OfflinePlugin. These are merged with the default values supplied by the PWA middleware using a deep object merge.

Environment

It is recommended to only use this middleware during building, or the production environment.

Example: Only use middleware during production:

module.exports = {
  use: [
    process.env.NODE_ENV === 'production' ? '@neutrinojs/pwa' : false,
  ]
};

Example: Only use middleware during production:

const pwa = require('@neutrinojs/pwa');

neutrino.config.when(process.env.NODE_ENV === 'production', () => {
  neutrino.use(pwa);
});

Customization

@neutrinojs/pwa creates some conventions to make overriding the configuration easier once you are ready to make changes.

Plugins

The following is a list of plugins and their identifiers which can be overridden:

Contributing

This middleware is part of the neutrino repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.