Adding Config options to workbox-sw setConfig()

packages/workbox-precaching/_types.mjs

@@ -19,12 +19,11 @@ import './_version.mjs';
 /**
  * @typedef {Object} InstallResult
  * @property {
- * Array<module:workbox-precaching.PrecacheController.PrecacheEntry|string>
+ * Array<workbox.precaching.PrecacheEntry|string>
  * } updatedEntries List of entries
  * supplied for precaching that were precached.
- * @property {
- * Array<module:workbox-precaching.PrecacheController.PrecacheEntry|string>
- * } notUpdatedEntries List of entries
+ * @property {Array<workbox.precaching.PrecacheEntry|string>}
+ * notUpdatedEntries List of entries
  * supplied for precaching that were already precached.
  *
  * @memberof workbox.precaching

packages/workbox-precaching/controllers/PrecacheController.mjs

@@ -146,7 +146,7 @@ class PrecacheController {
    * @param {Array<Object>} options.plugins Plugins to be used for fetching
    * and caching during install.
    * @return {
-   * Promise<module:workbox-precaching.PrecacheController.InstallResult>}
+   * Promise<workbox.precaching.InstallResult>}
    */
   async install(options = {}) {
     if (process.env.NODE_ENV !== 'production') {
@@ -229,7 +229,7 @@ class PrecacheController {
    * This should be called in the service worker activate event.
    *
    * @return {
-   * Promise<module:workbox-precaching.PrecacheController.CleanupResult>}
+   * Promise<workbox.precaching.CleanupResult>}
    * Resolves with an object containing details of the deleted cache requests
    * and precache revision details.
    */

packages/workbox-strategies/_default.mjs

@@ -23,27 +23,27 @@ import './_version.mjs';
 
 /**
  * @function workbox.strategies.cacheFirst
- * @param {StrategyOptions} options
+ * @param {workbox.strategies.StrategyOptions} options
  */
 
 /**
  * @function workbox.strategies.cacheOnly
- * @param {StrategyOptions} options
+ * @param {workbox.strategies.StrategyOptions} options
  */
 
 /**
  * @function workbox.strategies.networkFirst
- * @param {StrategyOptions} options
+ * @param {workbox.strategies.StrategyOptions} options
  */
 
 /**
  * @function workbox.strategies.networkOnly
- * @param {StrategyOptions} options
+ * @param {workbox.strategies.StrategyOptions} options
  */
 
 /**
  * @function workbox.strategies.staleWhileRevalidate
- * @param {StrategyOptions} options
+ * @param {workbox.strategies.StrategyOptions} options
  */
 
 const mapping = {

packages/workbox-sw/_types.mjs

@@ -0,0 +1,32 @@
+/*
+  Copyright 2017 Google Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import './_version.mjs';
+
+/**
+ * A `ModulePathCallback` function can be used to modify the modify the where
+ * Workbox modules are loaded.
+ *
+ * @callback ~ModulePathCallback
+ * @param {string} moduleName The name of the module to load (i.e.
+ * 'workbox-core', 'workbox-precaching' etc.).
+ * @param {boolean} debug When true, `dev` builds should be loaded, otherwise
+ * load `prod` builds.
+ * @return {string} This callback should return a path of module. This will
+ * be passed to `importScripts()`.
+ *
+ * @memberof workbox
+ */

packages/workbox-sw/controllers/WorkboxSW.mjs

@@ -75,7 +75,15 @@ class WorkboxSW {
    * debug build and whether to use a CDN or a specific path when importing
    * other workbox-modules
    *
-   * @param {Object=} [options]
+   * @param {Object} [options]
+   * @param {boolean} [options.debug] If true, `dev` builds are using, otherwise
+   * `prod` builds are used. By default, `prod` is used unless on localhost.
+   * @param {Function} [options.modulePathPrefix] To avoid using the CDN with
+   * `workbox-sw` set the path prefix of where modules should be loaded from.
+   * For example `modulePathPrefix: '/third_party/workbox/v3.0.0/'`.
+   * @param {workbox~ModulePathCallback} [options.modulePathCb] If defined,
+   * this callback will be responsible for determining the path of each
+   * workbox module.
    *
    * @alias workbox.setConfig
    */