Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
workbox-build
Advanced tools
workbox-build - npm Package Compare versions
Comparing version 3.0.0-alpha.6 to 3.0.0-beta.0
@@ -5,3 +5,3 @@ { | ||
| "releasesDir": "releases", | ||
| "latestVersion": "3.0.0-alpha.6" | ||
| "latestVersion": "3.0.0-beta.0" | ||
| } |
@@ -19,3 +19,4 @@ 'use strict'; | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#generateswstring_mode). | ||
| * @return {Promise<String>} A populated service worker template, based on the | ||
@@ -22,0 +23,0 @@ * other configuration options provided. |
@@ -25,3 +25,4 @@ 'use strict'; | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#full_generatesw_config). | ||
| * @return {Promise<{count: Number, size: Number}>} A promise that resolves once | ||
@@ -28,0 +29,0 @@ * the service worker file has been written to `swDest`. The `size` property |
@@ -16,3 +16,4 @@ 'use strict'; | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#getmanifest_mode). | ||
| * @return {Promise<{manifestEntries: Array<ManifestEntry>, | ||
@@ -19,0 +20,0 @@ * count: Number, size: Number}>} A promise that resolves once the precache |
@@ -25,3 +25,4 @@ 'use strict'; | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#full_injectmanifest_config). | ||
| * @return {Promise<{count: Number, size: Number}>} A promise that resolves once | ||
@@ -28,0 +29,0 @@ * the service worker file has been written to `swDest`. The `size` property |
@@ -22,6 +22,7 @@ 'use strict'; | ||
| var defaults = require('./defaults'); | ||
| var regExpObject = require('./reg-exp-object'); | ||
| // Define some common constrains used by all methods. | ||
| module.exports = joi.object().keys({ | ||
| dontCacheBustUrlsMatching: joi.object().type(RegExp), | ||
| dontCacheBustUrlsMatching: regExpObject, | ||
| globFollow: joi.boolean().default(defaults.globFollow), | ||
@@ -28,0 +29,0 @@ globIgnores: joi.array().items(joi.string()).default(defaults.globIgnores), |
@@ -23,2 +23,3 @@ 'use strict'; | ||
| var defaults = require('./defaults'); | ||
| var regExpObject = require('./reg-exp-object'); | ||
@@ -30,8 +31,8 @@ // Add some constraints that apply to both generateSW and generateSWString. | ||
| directoryIndex: joi.string(), | ||
| ignoreUrlParametersMatching: joi.array().items(joi.object().type(RegExp)), | ||
| ignoreUrlParametersMatching: joi.array().items(regExpObject), | ||
| navigateFallback: joi.string().default(defaults.navigateFallback), | ||
| navigateFallbackBlacklist: joi.array().items(joi.object().type(RegExp)), | ||
| navigateFallbackWhitelist: joi.array().items(joi.object().type(RegExp)), | ||
| navigateFallbackBlacklist: joi.array().items(regExpObject), | ||
| navigateFallbackWhitelist: joi.array().items(regExpObject), | ||
| runtimeCaching: joi.array().items(joi.object().keys({ | ||
| urlPattern: [joi.object().type(RegExp), joi.string()], | ||
| urlPattern: [regExpObject, joi.string()], | ||
| handler: [joi.func(), joi.string().valid('cacheFirst', 'cacheOnly', 'networkFirst', 'networkOnly', 'staleWhileRevalidate')], | ||
@@ -38,0 +39,0 @@ options: joi.object().keys({ |
@@ -23,8 +23,9 @@ 'use strict'; | ||
| var defaults = require('./defaults'); | ||
| var regExpObject = require('./reg-exp-object'); | ||
| module.exports = baseSchema.keys({ | ||
| globDirectory: joi.string().required(), | ||
| injectionPointRegexp: joi.object().type(RegExp).default(defaults.injectionPointRegexp), | ||
| injectionPointRegexp: regExpObject.default(defaults.injectionPointRegexp), | ||
| swSrc: joi.string().required(), | ||
| swDest: joi.string().required() | ||
| }); |
| { | ||
| "name": "workbox-build", | ||
| "version": "3.0.0-alpha.6", | ||
| "version": "3.0.0-beta.0", | ||
| "description": "A module that integrates into your build process, helping you generate a manifest of local files that workbox-sw should precache.", | ||
@@ -29,12 +29,12 @@ "keywords": [ | ||
| "lodash.template": "^4.4.0", | ||
| "workbox-background-sync": "^3.0.0-alpha.6", | ||
| "workbox-broadcast-cache-update": "^3.0.0-alpha.6", | ||
| "workbox-cache-expiration": "^3.0.0-alpha.6", | ||
| "workbox-cacheable-response": "^3.0.0-alpha.6", | ||
| "workbox-core": "^3.0.0-alpha.6", | ||
| "workbox-google-analytics": "^3.0.0-alpha.6", | ||
| "workbox-precaching": "^3.0.0-alpha.6", | ||
| "workbox-routing": "^3.0.0-alpha.6", | ||
| "workbox-strategies": "^3.0.0-alpha.6", | ||
| "workbox-sw": "^3.0.0-alpha.6" | ||
| "workbox-background-sync": "^3.0.0-beta.0", | ||
| "workbox-broadcast-cache-update": "^3.0.0-beta.0", | ||
| "workbox-cache-expiration": "^3.0.0-beta.0", | ||
| "workbox-cacheable-response": "^3.0.0-beta.0", | ||
| "workbox-core": "^3.0.0-beta.0", | ||
| "workbox-google-analytics": "^3.0.0-beta.0", | ||
| "workbox-precaching": "^3.0.0-beta.0", | ||
| "workbox-routing": "^3.0.0-beta.0", | ||
| "workbox-strategies": "^3.0.0-beta.0", | ||
| "workbox-sw": "^3.0.0-beta.0" | ||
| }, | ||
@@ -41,0 +41,0 @@ "main": "build/index.js", |
@@ -19,355 +19,2 @@ /* | ||
| /** | ||
| * These are the full set of options that could potentially be used to configure | ||
| * one of the build tools. Each of the build tools has a slightly different way | ||
| * of providing this configuration: | ||
| * | ||
| * - When using the `workbox-build` module directly, pass the | ||
| * configuration object to appropriate method. For example, | ||
| * `workboxBuild.injectManifest(configuration)` or | ||
| * `workboxBuild.generateSW(configuration)`. | ||
| * | ||
| * - When using the `workbox-cli` command line interface, use the | ||
| * `--config-file` flag to point to a | ||
| * [CommonJS module file](https://nodejs.org/docs/latest/api/modules.html) that | ||
| * assigns the configuration object to `module.exports`. | ||
| * | ||
| * - When using `workbox-webpack-plugin` within a | ||
| * [Webpack](https://webpack.js.org/) build, pass the configuration object to | ||
| * the plugin's constructor, like | ||
| * `new WorkboxBuildWebpackPlugin(configuration)`. | ||
| * | ||
| * Some specific options might not make sense with certain combinations of | ||
| * interfaces. In those cases, the limitations are called out in the | ||
| * documentation, and may lead to build-time warnings or errors. | ||
| * | ||
| * Each option documented here includes an example, which, for the sake of | ||
| * illustration, assumes the following local filesystem setup. Please adjust | ||
| * the example values to match your actual setup. | ||
| * | ||
| * ```sh | ||
| * ./ | ||
| * ├── dev/ | ||
| * │ ├── app.js | ||
| * │ ├── ignored.html | ||
| * │ ├── image.png | ||
| * │ ├── index.html | ||
| * │ ├── main.css | ||
| * │ ├── sw.js | ||
| * │ └── templates/ | ||
| * │ └── app_shell.hbs | ||
| * └── dist/ | ||
| * ├── app.js | ||
| * ├── image.png | ||
| * ├── index.html | ||
| * ├── main.css | ||
| * └── sw.js | ||
| * ``` | ||
| * | ||
| * @typedef {Object} Configuration | ||
| * | ||
| * @property {String} swDest The path to the final service worker | ||
| * file that will be created by the build process, relative to the current | ||
| * working directory. | ||
| * | ||
| * E.g.: `'./dist/sw.js'` | ||
| * | ||
| * Note: This option is only valid when used with | ||
| * {@link module:workbox-build.generateSW|generateSW()} or | ||
| * {@link module:workbox-build.injectManifest|injectManifest()}. | ||
| * | ||
| * @property {String} swSrc The path to the source service worker | ||
| * containing a `precache([])` placeholder, which will be replaced with the | ||
| * precache manifest generated by the build. | ||
| * | ||
| * E.g.: `'./dev/sw.js'` | ||
| * | ||
| * Note: This option is only valid when used with | ||
| * {@link module:workbox-build.injectManifest|injectManifest()}. | ||
| * | ||
| * @property {String} swTemplate A service worker template that should be | ||
| * populated based on the configuration provided. The template should be in a | ||
| * format that [`lodash.template`](https://lodash.com/docs/4.17.4#template) | ||
| * understands. | ||
| * | ||
| * Note: This option is only valid when used with | ||
| * {@link module:workbox-build.generateSWNoFS|generateSWNoFS()}. | ||
| * | ||
| * @property {boolean} [importWorkboxFromCDN=true] If `true`, the WorkboxSW | ||
| * runtime will be automatically imported into the generated service worker from | ||
| * the official CDN URL. If `false`, the WorkboxSW runtime will be copied | ||
| * locally into your `swDest` directory when using | ||
| * {@link module:workbox-build.generateSW|generateSW()}. | ||
| * If `process.env.NODE_ENV` is set to a string starting with `dev` then the | ||
| * `dev` bundle of WorkboxSW, with additional assertions and debugging info, | ||
| * will be used; otherwise, the `prod` bundle will be used. | ||
| * | ||
| * Note: This option is only valid when used with | ||
| * {@link module:workbox-build.generateSW|generateSW()} or | ||
| * {@link module:workbox-build.generateSWNoFS|generateSWNoFS()}. | ||
| * | ||
| * @property {Array<String>} [importScripts] An optional list of JavaScript | ||
| * files that should be passed to | ||
| * [`importScripts()`](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts) | ||
| * inside the generated service worker file. | ||
| * | ||
| * Note: This option is only valid when used with | ||
| * {@link module:workbox-build.generateSW|generateSW()} or | ||
| * {@link module:workbox-build.generateSWNoFS|generateSWNoFS()}. | ||
| * | ||
| * @property {Array<String>} [globPatterns=['**\/*.{js,css,html}']] | ||
| * Files matching against any of these | ||
| * [glob patterns](https://github.com/isaacs/node-glob) will be included in the | ||
| * precache manifest. | ||
| * | ||
| * E.g.: `'**\/*.{js,css,html,png}'` | ||
| * | ||
| * @property {String} globDirectory The base directory you wish to | ||
| * match `globPatterns` against, related to the current working directory. | ||
| * | ||
| * E.g.: `'./dev'` | ||
| * | ||
| * @property {String|Array<String>} [globIgnores='node_modules'] | ||
| * Files matching against any of these glob patterns will be excluded from the | ||
| * file manifest, overriding any matches from `globPatterns`. | ||
| * | ||
| * E.g. `['**\/ignored.html']` | ||
| * | ||
| * @property {Boolean} [globFollow=true] Follow symlinked directories when | ||
| * expanding '**' patterns. Note that this can result in a lot of duplicate | ||
| * references in the presence of cyclic links. | ||
| * | ||
| * @property {Boolean} [globStrict=true] When an unusual error is encountered | ||
| * when attempting to read a directory, the process will just continue on in | ||
| * search of other matches. Set the strict option to raise an error in these | ||
| * cases. | ||
| * | ||
| * @property {Object<String,Array|string>} [templatedUrls] | ||
| * If a URL is rendered generated based on some server-side logic, its contents | ||
| * may depend on multiple files or on some other unique string value. | ||
| * | ||
| * If used with an array of strings, they will be interpreted as | ||
| * [glob patterns](https://github.com/isaacs/node-glob), and the contents of | ||
| * any files matching the patterns will be used to uniquely version the URL. | ||
| * | ||
| * If used with a single string, it will be interpreted as unique versioning | ||
| * information that you've generated out of band for a given URL. | ||
| * | ||
| * E.g. | ||
| * ```js | ||
| * { | ||
| * '/app-shell': [ | ||
| * 'dev/templates/app-shell.hbs', | ||
| * 'dev/**\/*.css', | ||
| * ], | ||
| * '/other-page': 'my-version-info', | ||
| * } | ||
| * ``` | ||
| * | ||
| * @property {number} [maximumFileSizeToCacheInBytes=2097152] | ||
| * This value can be used to determine the maximum size of files that will be | ||
| * precached. This prevents you from inadvertantly precaching very large files | ||
| * that might have been accidentally match your `globPatterns` values. | ||
| * | ||
| * @property {Array<ManifestTransform>} [manifestTransforms] An array of | ||
| * manifest transformations, which will be applied sequentially against the | ||
| * generated manifest. If `modifyUrlPrefix` or `dontCacheBustUrlsMatching` are | ||
| * also specified, their corresponding transformations will be applied first. | ||
| * | ||
| * See {@link module:workbox-build.ManifestTransform|ManifestTransform}. | ||
| * | ||
| * @property {Object<String,String>} [modifyUrlPrefix] A mapping of | ||
| * prefixes that, if present in an entry in the precache manifest, will be | ||
| * replaced with the corresponding value. | ||
| * | ||
| * This can be used to, for example, remove or add a path prefix from a manifest | ||
| * entry if your web hosting setup doesn't match your local filesystem setup. | ||
| * | ||
| * As an alternative with more flexibility, you can use the `manifestTransforms` | ||
| * option and provide a function that modifies the entries in the manifest using | ||
| * whatever logic you provide. | ||
| * | ||
| * E.g. | ||
| * ```js | ||
| * { | ||
| * '/prefix-to-remove': '', | ||
| * } | ||
| * ``` | ||
| * | ||
| * @property {RegExp} [dontCacheBustUrlsMatching] Assets that match this | ||
| * regex will be assumed to be uniquely versioned via their URL, an exempted | ||
| * from the normal HTTP cache-busting that's done when populating the precache. | ||
| * | ||
| * While not required, it's recommended that if your existing build process | ||
| * already inserts a `[hash]` value into each filename, you provide a RegExp | ||
| * that will detect those values, as it will reduce the amount of bandwidth | ||
| * consumed when precaching. | ||
| * | ||
| * E.g. `/\.\w{8}\./` | ||
| * | ||
| * @property {String} [navigateFallback] This will be used to create a | ||
| * {@link workbox.routing.NavigationRoute|NavigationRoute} that will | ||
| * respond to navigation requests for URLs that that aren't precached. | ||
| * | ||
| * This is meant to be used in a | ||
| * [Single Page App](https://en.wikipedia.org/wiki/Single-page_application) | ||
| * scenario, in which you want all navigations to result in common App Shell | ||
| * HTML being reused. | ||
| * | ||
| * It's *not* intended for use as a fallback that's displayed when the browser | ||
| * is offline. | ||
| * | ||
| * 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 add in a call to | ||
| * {@link module:workbox-sw.Router#registerNavigationRoute| | ||
| * registerNavigationRoute()} | ||
| * in your `swSrc` file. | ||
| * | ||
| * E.g. `'/app-shell'` | ||
| * | ||
| * @property {Array<RegExp>} [navigateFallbackWhitelist=/./] An optional | ||
| * array of regular expressions that restrict which URLs the navigation route | ||
| * applies to. | ||
| * | ||
| * 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 add in the whitelist when calling | ||
| * {@link module:workbox-sw.Router#registerNavigationRoute| | ||
| * registerNavigationRoute()} | ||
| * in your `swSrc` file. | ||
| * | ||
| * E.g. `[/pages/, /articles/]` | ||
| * | ||
| * @property {String} [cacheId] An optional ID to be prepended to caches | ||
| * used by `workbox-sw`. This is primarily useful for local development where | ||
| * multiple sites may be served from the same `http://localhost` origin. | ||
| * | ||
| * 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. `'my-app-name'` | ||
| * | ||
| * @property {Boolean} [skipWaiting=false] Whether or not the service worker | ||
| * should skip over the [waiting](https://developers.google.com/web/fundamentals/instant-and-offline/service-worker/lifecycle#waiting) | ||
| * lifecycle stage. | ||
| * | ||
| * 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. | ||
| * | ||
| * @property {Boolean} [clientsClaim=false] Whether or not the service worker | ||
| * should [start controlling](https://developers.google.com/web/fundamentals/instant-and-offline/service-worker/lifecycle#clientsclaim) | ||
| * any existing clients as soon as it activates. | ||
| * | ||
| * 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. | ||
| * | ||
| * @property {string} [directoryIndex='index.html'] If a request for a URL | ||
| * ending in '/' fails, this value will be appended to the URL and a second | ||
| * request will be made. | ||
| * | ||
| * This should be configured to whatever your web server is using, if anything, | ||
| * for its [directory index](https://httpd.apache.org/docs/2.0/mod/mod_dir.html). | ||
| * | ||
| * 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. | ||
| * | ||
| * @property {Array<Object>} [runtimeCaching] Passing in an array of objects | ||
| * containing `urlPattern`s, `handler`s, and potentially `option`s that will add | ||
| * the appropriate code to the generated service worker to handle runtime | ||
| * caching. | ||
| * | ||
| * Requests for precached URLs that are picked up via `globPatterns` are handled | ||
| * by default, and don't need to be accomodated in `runtimeCaching`. | ||
| * | ||
| * The `handler` values correspond the names of the | ||
| * {@link module:workbox-sw.Strategies|strategies} supported by `workbox-sw`. | ||
| * | ||
| * | ||
| * 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 add in the corresponding runtime caching behavior via | ||
| * {@link module:workbox-sw.Router#registerRoute|registerRoute()} in your | ||
| * `swSrc` file. | ||
| * | ||
| * E.g. | ||
| * ```js | ||
| * [{ | ||
| * // You can use a RegExp as the pattern: | ||
| * urlPattern: /.jpg$/, | ||
| * handler: 'cacheFirst', | ||
| * // Any options provided will be used when | ||
| * // creating the caching strategy. | ||
| * options: { | ||
| * cacheName: 'image-cache', | ||
| * cacheExpiration: { | ||
| * maxEntries: 10, | ||
| * }, | ||
| * }, | ||
| * }, { | ||
| * // You can also use Express-style strings: | ||
| * urlPattern: 'https://example.com/path/to/:file', | ||
| * handler: 'staleWhileRevalidate', | ||
| * options: { | ||
| * cacheableResponse: { | ||
| statuses: [0], | ||
| * }, | ||
| * }, | ||
| * }] | ||
| * ``` | ||
| * | ||
| * @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. | ||
| * | ||
| * @memberof module:workbox-build | ||
| */ | ||
| /** | ||
@@ -374,0 +21,0 @@ * @typedef {Object} ManifestEntry |
@@ -5,3 +5,3 @@ { | ||
| "releasesDir": "releases", | ||
| "latestVersion": "3.0.0-alpha.6" | ||
| "latestVersion": "3.0.0-beta.0" | ||
| } |
@@ -26,3 +26,4 @@ /* | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#generateswstring_mode). | ||
| * @return {Promise<String>} A populated service worker template, based on the | ||
@@ -29,0 +30,0 @@ * other configuration options provided. |
@@ -37,3 +37,4 @@ /* | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#full_generatesw_config). | ||
| * @return {Promise<{count: Number, size: Number}>} A promise that resolves once | ||
@@ -40,0 +41,0 @@ * the service worker file has been written to `swDest`. The `size` property |
@@ -26,3 +26,4 @@ /* | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#getmanifest_mode). | ||
| * @return {Promise<{manifestEntries: Array<ManifestEntry>, | ||
@@ -29,0 +30,0 @@ * count: Number, size: Number}>} A promise that resolves once the precache |
@@ -37,3 +37,4 @@ /* | ||
| * | ||
| * @param {module:workbox-build.Configuration} config | ||
| * @param {Object} config Please refer to the | ||
| * [configuration guide](https://developers.google.com/web/tools/workbox/modules/workbox-build#full_injectmanifest_config). | ||
| * @return {Promise<{count: Number, size: Number}>} A promise that resolves once | ||
@@ -40,0 +41,0 @@ * the service worker file has been written to `swDest`. The `size` property |
@@ -20,6 +20,7 @@ /* | ||
| const defaults = require('./defaults'); | ||
| const regExpObject = require('./reg-exp-object'); | ||
| // Define some common constrains used by all methods. | ||
| module.exports = joi.object().keys({ | ||
| dontCacheBustUrlsMatching: joi.object().type(RegExp), | ||
| dontCacheBustUrlsMatching: regExpObject, | ||
| globFollow: joi.boolean().default(defaults.globFollow), | ||
@@ -26,0 +27,0 @@ globIgnores: joi.array().items(joi.string()).default(defaults.globIgnores), |
@@ -21,2 +21,3 @@ /* | ||
| const defaults = require('./defaults'); | ||
| const regExpObject = require('./reg-exp-object'); | ||
@@ -28,8 +29,8 @@ // Add some constraints that apply to both generateSW and generateSWString. | ||
| directoryIndex: joi.string(), | ||
| ignoreUrlParametersMatching: joi.array().items(joi.object().type(RegExp)), | ||
| ignoreUrlParametersMatching: joi.array().items(regExpObject), | ||
| navigateFallback: joi.string().default(defaults.navigateFallback), | ||
| navigateFallbackBlacklist: joi.array().items(joi.object().type(RegExp)), | ||
| navigateFallbackWhitelist: joi.array().items(joi.object().type(RegExp)), | ||
| navigateFallbackBlacklist: joi.array().items(regExpObject), | ||
| navigateFallbackWhitelist: joi.array().items(regExpObject), | ||
| runtimeCaching: joi.array().items(joi.object().keys({ | ||
| urlPattern: [joi.object().type(RegExp), joi.string()], | ||
| urlPattern: [regExpObject, joi.string()], | ||
| handler: [joi.func(), joi.string().valid( | ||
@@ -36,0 +37,0 @@ 'cacheFirst', |
@@ -21,9 +21,9 @@ /* | ||
| const defaults = require('./defaults'); | ||
| const regExpObject = require('./reg-exp-object'); | ||
| module.exports = baseSchema.keys({ | ||
| globDirectory: joi.string().required(), | ||
| injectionPointRegexp: joi.object().type(RegExp) | ||
| .default(defaults.injectionPointRegexp), | ||
| injectionPointRegexp: regExpObject.default(defaults.injectionPointRegexp), | ||
| swSrc: joi.string().required(), | ||
| swDest: joi.string().required(), | ||
| }); |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by1.43%
71
Worsened metrics
- Total package byte prevSize
- decreased by-13.44%
151006
- Lines of code
- decreased by-8.2%
3449
Dependency changes
Updatedworkbox-core@^3.0.0-beta.0
Updatedworkbox-sw@^3.0.0-beta.0