workbox-build - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

build/cdn-details.json

@@ -5,3 +5,3 @@ {
   "releasesDir": "releases",
-  "latestVersion": "3.0.0"
+  "latestVersion": "3.0.1"
 }

build/index.js

@@ -51,5 +51,38 @@ 'use strict';
  *
- * @module workbox-build
+ * @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
  */
 
+
 module.exports = {
@@ -56,0 +89,0 @@ copyWorkboxLibraries,

build/lib/filter-files.js

@@ -70,5 +70,5 @@ 'use strict';
  * @callback ManifestTransform
- * @param {Array<ManifestEntry>} manifestEntries The full array of entries,
- * prior to the current transformation.
- * @return {{manifest: Array<ManifestEntry>, warnings: Array<String>|undefined}}
+ * @param {Array<module:workbox-build.ManifestEntry>} manifestEntries The full
+ * array of entries, prior to the current transformation.
+ * @return {module:workbox-build.ManifestTransformResult}
  * The array of entries with the transformation applied, and optionally, any
@@ -75,0 +75,0 @@ * warnings that should be reported back to the build tool.

build/lib/modify-url-prefix-transform.js

@@ -33,2 +33,3 @@ 'use strict';
  *
+ * @private
  * @param  {string} string The string to be used as part of a regular
@@ -35,0 +36,0 @@ *                         expression

package.json

 {
   "name": "workbox-build",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "A module that integrates into your build process, helping you generate a manifest of local files that workbox-sw should precache.",
@@ -30,12 +30,12 @@ "keywords": [
     "pretty-bytes": "^4.0.2",
-    "workbox-background-sync": "^3.0.0",
-    "workbox-broadcast-cache-update": "^3.0.0",
-    "workbox-cache-expiration": "^3.0.0",
-    "workbox-cacheable-response": "^3.0.0",
-    "workbox-core": "^3.0.0",
-    "workbox-google-analytics": "^3.0.0",
-    "workbox-precaching": "^3.0.0",
-    "workbox-routing": "^3.0.0",
-    "workbox-strategies": "^3.0.0",
-    "workbox-sw": "^3.0.0"
+    "workbox-background-sync": "^3.0.1",
+    "workbox-broadcast-cache-update": "^3.0.1",
+    "workbox-cache-expiration": "^3.0.1",
+    "workbox-cacheable-response": "^3.0.1",
+    "workbox-core": "^3.0.1",
+    "workbox-google-analytics": "^3.0.1",
+    "workbox-precaching": "^3.0.1",
+    "workbox-routing": "^3.0.1",
+    "workbox-strategies": "^3.0.1",
+    "workbox-sw": "^3.0.1"
   },
@@ -42,0 +42,0 @@ "main": "build/index.js",

src/_types.js

@@ -27,1 +27,9 @@ /*
  */
+
+/**
+ * @typedef {Object} ManifestTransformResult
+ * @property {Array<ManifestEntry>} manifest
+ * @property {Array<string>|undefined} warnings
+ *
+ * @memberof module:workbox-build
+ */

src/cdn-details.json

@@ -5,3 +5,3 @@ {
   "releasesDir": "releases",
-  "latestVersion": "3.0.0"
+  "latestVersion": "3.0.1"
 }

src/index.js

@@ -47,5 +47,36 @@ /*
  *
- * @module workbox-build
+ * @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
  */
-
 module.exports = {
@@ -52,0 +83,0 @@ copyWorkboxLibraries,

src/lib/filter-files.js

@@ -63,5 +63,5 @@ /*
  * @callback ManifestTransform
- * @param {Array<ManifestEntry>} manifestEntries The full array of entries,
- * prior to the current transformation.
- * @return {{manifest: Array<ManifestEntry>, warnings: Array<String>|undefined}}
+ * @param {Array<module:workbox-build.ManifestEntry>} manifestEntries The full
+ * array of entries, prior to the current transformation.
+ * @return {module:workbox-build.ManifestTransformResult}
  * The array of entries with the transformation applied, and optionally, any
@@ -68,0 +68,0 @@ * warnings that should be reported back to the build tool.

src/lib/modify-url-prefix-transform.js

@@ -25,2 +25,3 @@ /*
  *
+ * @private
  * @param  {string} string The string to be used as part of a regular
@@ -27,0 +28,0 @@ *                         expression

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

160878

increased by2.04%

Lines of code

3702

increased by2.01%

Dependency changes

• Updatedworkbox-background-sync@^3.0.1

• Updatedworkbox-broadcast-cache-update@^3.0.1

• Updatedworkbox-cache-expiration@^3.0.1

• Updatedworkbox-cacheable-response@^3.0.1

• Updatedworkbox-core@^3.0.1

• Updatedworkbox-google-analytics@^3.0.1

• Updatedworkbox-precaching@^3.0.1

• Updatedworkbox-routing@^3.0.1

• Updatedworkbox-strategies@^3.0.1

• Updatedworkbox-sw@^3.0.1