You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
3.6 KiB
88 lines
3.6 KiB
"use strict";
|
|
|
|
/*
|
|
Copyright 2018 Google LLC
|
|
|
|
Use of this source code is governed by an MIT-style
|
|
license that can be found in the LICENSE file or at
|
|
https://opensource.org/licenses/MIT.
|
|
*/
|
|
const copyWorkboxLibraries = require('./lib/copy-workbox-libraries');
|
|
|
|
const generateSW = require('./entry-points/generate-sw');
|
|
|
|
const generateSWString = require('./entry-points/generate-sw-string');
|
|
|
|
const getManifest = require('./entry-points/get-manifest');
|
|
|
|
const injectManifest = require('./entry-points/inject-manifest');
|
|
|
|
const _require = require('./lib/cdn-utils'),
|
|
getModuleURL = _require.getModuleURL;
|
|
/**
|
|
* This Node module can be used to generate a list of assets that should be
|
|
* precached in a service worker, generating a hash that can be used to
|
|
* intelligently update a cache when the service worker is updated.
|
|
*
|
|
* This module will use glob patterns to find assets in a given directory
|
|
* and use the resulting URL and revision data for one of the follow uses:
|
|
*
|
|
* 1. Generate a complete service worker with precaching and some basic
|
|
* configurable options, writing the resulting service worker file to disk. See
|
|
* [generateSW()]{@link module:workbox-build.generateSW}.
|
|
* 1. Generate a complete service worker with precaching and some basic
|
|
* configurable options, without writing the results to disk. See
|
|
* [generateSWString()]{@link module:workbox-build.generateSWString}.
|
|
* 1. Inject a manifest into an existing service worker. This allows you
|
|
* to control your own service worker while still taking advantage of
|
|
* [workboxSW.precache()]{@link module:workbox-sw.WorkboxSW#precache} logic.
|
|
* See [injectManifest()]{@link module:workbox-build.injectManifest}.
|
|
* 1. Just generate a manifest, not a full service worker file.
|
|
* This is useful if you want to make use of the manifest from your own existing
|
|
* service worker file and are okay with including the manifest yourself.
|
|
* See [getManifest()]{@link module:workbox-build.getManifest}.
|
|
*
|
|
* @property {Array<RegExp>} [ignoreURLParametersMatching=[/^utm_/]] Any
|
|
* search parameter names that match against one of the regex's in this array
|
|
* will be removed before looking for a precache match.
|
|
*
|
|
* This is useful if your users might request URLs that contain, for example,
|
|
* URL parameters used to track the source of the traffic. Those URL parameters
|
|
* would normally cause the cache lookup to fail, since the URL strings used
|
|
* as cache keys would not be expected to include them.
|
|
*
|
|
* You can use `[/./]` to ignore all URL parameters.
|
|
*
|
|
* Note: This option is only valid when used with
|
|
* {@link module:workbox-build#generateSW|generateSW()}. When using
|
|
* {@link module:workbox-build.injectManifest|injectManifest()}, you can
|
|
* explicitly pass the desired value in to the
|
|
* {@link module:workbox-sw.WorkboxSW|WorkboxSW() constructor} in your `swSrc`
|
|
* file.
|
|
*
|
|
* E.g. `[/homescreen/]`
|
|
*
|
|
* @property {Boolean} [handleFetch=true] Whether or not `workbox-sw` should
|
|
* create a `fetch` event handler that responds to network requests. This is
|
|
* useful during development if you don't want the service worker serving stale
|
|
* content.
|
|
*
|
|
* Note: This option is only valid when used with
|
|
* {@link module:workbox-build#generateSW|generateSW()}. When using
|
|
* {@link module:workbox-build.injectManifest|injectManifest()}, you can
|
|
* explicitly pass the desired value in to the
|
|
* {@link module:workbox-sw.WorkboxSW|WorkboxSW() constructor} in your `swSrc`
|
|
* file.
|
|
*
|
|
* @module workbox-build
|
|
*/
|
|
|
|
|
|
module.exports = {
|
|
copyWorkboxLibraries,
|
|
generateSW,
|
|
generateSWString,
|
|
getManifest,
|
|
getModuleURL,
|
|
injectManifest
|
|
};
|