From 628c8a578b9e4ce738c4d3f75855c8f2748fa71b Mon Sep 17 00:00:00 2001
From: Jeff Posnick <jeffy@google.com>
Date: Mon, 9 May 2022 10:27:46 -0400
Subject: [PATCH] Tweak TSDocs

---
 packages/workbox-build/src/types.ts           | 26 ++++++++++++++++---
 .../workbox-routing/src/NavigationRoute.ts    |  5 ++++
 2 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/packages/workbox-build/src/types.ts b/packages/workbox-build/src/types.ts
index 95d70e2c9..f3c79553d 100644
--- a/packages/workbox-build/src/types.ts
+++ b/packages/workbox-build/src/types.ts
@@ -166,13 +166,23 @@ export interface BasePartial {
    */
   maximumFileSizeToCacheInBytes?: number;
   /**
-   * 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
+   * An object mapping string prefixes to replacement string values. This can be
+   * used to, e.g., 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.
+   *
+   * Example usage:
+   *
+   * ```
+   * // Replace a '/dist/' prefix with '/', and also prepend
+   * // '/static' to every URL.
+   * modifyURLPrefix: {
+   *   '/dist/': '/',
+   *   '': '/static',
+   * }
+   * ```
    */
   modifyURLPrefix?: {
     [key: string]: string;
@@ -269,6 +279,11 @@ export interface GeneratePartial {
    * [Single Page App](https://en.wikipedia.org/wiki/Single-page_application).
    * If both `navigateFallbackDenylist` and `navigateFallbackAllowlist` are
    * configured, the denylist takes precedent.
+   *
+   * *Note*: These RegExps may be evaluated against every destination URL during
+   * a navigation. Avoid using
+   * [complex RegExps](https://github.com/GoogleChrome/workbox/issues/3077),
+   * or else your users may see delays when navigating your site.
    */
   navigateFallbackAllowlist?: Array<RegExp>;
   /**
@@ -278,6 +293,11 @@ export interface GeneratePartial {
    * [Single Page App](https://en.wikipedia.org/wiki/Single-page_application).
    * If both `navigateFallbackDenylist` and `navigateFallbackAllowlist` are
    * configured, the denylist takes precedence.
+   *
+   * *Note*: These RegExps may be evaluated against every destination URL during
+   * a navigation. Avoid using
+   * [complex RegExps](https://github.com/GoogleChrome/workbox/issues/3077),
+   * or else your users may see delays when navigating your site.
    */
   navigateFallbackDenylist?: Array<RegExp>;
   /**
diff --git a/packages/workbox-routing/src/NavigationRoute.ts b/packages/workbox-routing/src/NavigationRoute.ts
index 69a7ca9ae..7c878cd7f 100644
--- a/packages/workbox-routing/src/NavigationRoute.ts
+++ b/packages/workbox-routing/src/NavigationRoute.ts
@@ -48,6 +48,11 @@ class NavigationRoute extends Route {
    * and [`search`]{@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLHyperlinkElementUtils/search}
    * portions of the requested URL.
    *
+   * *Note*: These RegExps may be evaluated against every destination URL during
+   * a navigation. Avoid using
+   * [complex RegExps](https://github.com/GoogleChrome/workbox/issues/3077),
+   * or else your users may see delays when navigating your site.
+   *
    * @param {workbox-routing~handlerCallback} handler A callback
    * function that returns a Promise resulting in a Response.
    * @param {Object} options