neutrino-middleware-pwa

Neutrino middleware for augmenting a Neutrino web application with Progressive Web Application capabilities

This package is deprecated. See: https://neutrinojs.org/migration-guide/#neutrino-v7-to-v8
Last updated 3 years ago by eliperelman .
MPL-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install neutrino-middleware-pwa 
SYNC missed versions from official npm registry.

Neutrino PWA Middleware

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

NPM version NPM downloads Join the Neutrino community on Spectrum

Requirements

  • Node.js v6.10+
  • Yarn or npm client
  • Neutrino v7

Installation

neutrino-middleware-pwa can be installed via the Yarn or npm clients.

Yarn

❯ yarn add neutrino-middleware-pwa

npm

❯ npm install --save neutrino-middleware-pwa

Usage

neutrino-middleware-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('neutrino-middleware-pwa');

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

// Usage showing overriding options
neutrino.use(pwa, {
  relativePaths: true
});
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['neutrino-middleware-pwa']
};

// Usage showing overriding options
module.exports = {
  use: [
    ['neutrino-middleware-pwa', { relativePaths: true }]
  ]
};

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 when building:

❯ neutrino build --use neutrino-preset-react neutrino-middleware-pwa

Example: Only use middleware during production:

module.exports = {
  env: {
    NODE_ENV: {
      production: {
        use: ['neutrino-middleware-pwa']
      }
    }
  }
};

Example: Only use middleware during production:

const pwa = require('neutrino-middleware-pwa');

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

Customization

neutrino-middleware-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:

Name Description Environments and Commands
pwa Creates an OfflinePlugin with options for setting up caching via Service Worker. all

Contributing

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

Current Tags

  • 7.4.0                                ...           latest (3 years ago)

38 Versions

  • 7.4.0 [deprecated]           ...           3 years ago
  • 7.3.3 [deprecated]           ...           3 years ago
  • 7.3.2 [deprecated]           ...           3 years ago
  • 7.3.1 [deprecated]           ...           3 years ago
  • 7.3.0 [deprecated]           ...           3 years ago
  • 7.2.3 [deprecated]           ...           3 years ago
  • 7.2.1 [deprecated]           ...           3 years ago
  • 7.2.0 [deprecated]           ...           3 years ago
  • 7.1.10 [deprecated]           ...           3 years ago
  • 7.1.9 [deprecated]           ...           3 years ago
  • 7.1.8 [deprecated]           ...           3 years ago
  • 7.1.7 [deprecated]           ...           3 years ago
  • 7.1.6 [deprecated]           ...           3 years ago
  • 7.1.5 [deprecated]           ...           3 years ago
  • 7.1.4 [deprecated]           ...           3 years ago
  • 7.1.3 [deprecated]           ...           3 years ago
  • 7.1.2 [deprecated]           ...           3 years ago
  • 7.1.1 [deprecated]           ...           3 years ago
  • 7.1.0 [deprecated]           ...           3 years ago
  • 7.0.2 [deprecated]           ...           3 years ago
  • 7.0.1 [deprecated]           ...           3 years ago
  • 7.0.0 [deprecated]           ...           3 years ago
  • 6.2.1 [deprecated]           ...           3 years ago
  • 6.2.0 [deprecated]           ...           3 years ago
  • 6.1.8 [deprecated]           ...           3 years ago
  • 6.1.7 [deprecated]           ...           3 years ago
  • 6.1.5 [deprecated]           ...           3 years ago
  • 6.1.4 [deprecated]           ...           3 years ago
  • 6.1.3 [deprecated]           ...           3 years ago
  • 6.1.2 [deprecated]           ...           3 years ago
  • 6.1.1 [deprecated]           ...           3 years ago
  • 6.1.0 [deprecated]           ...           3 years ago
  • 6.0.5 [deprecated]           ...           3 years ago
  • 6.0.4 [deprecated]           ...           3 years ago
  • 6.0.3 [deprecated]           ...           3 years ago
  • 6.0.2 [deprecated]           ...           3 years ago
  • 6.0.1 [deprecated]           ...           3 years ago
  • 6.0.0 [deprecated]           ...           3 years ago
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 0
Dependencies (2)
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2017 © taobao.org |