serwist 9.0.2 → 9.0.3

package/dist/legacy/setDefaultHandler.d.ts

@@ -1,12 +1,12 @@
 import type { RouteHandler } from "../types.js";
 /**
- * Defines a default `handler` that's called when no routes explicitly
+ * Defines a default handler that's called when no routes explicitly
  * match the incoming request.
  *
- * Without a default `handler`, unmatched requests will go against the
+ * Without a default handler, unmatched requests will go against the
  * network as if there were no service worker present.
  *
- * @param handler A callback function that returns a Promise resulting in a Response.
+ * @param handler A callback function that returns a promise resulting in a response.
  * @deprecated
  */
 export declare const setDefaultHandler: (handler: RouteHandler) => void;

package/dist/legacy/singletonPrecacheController.d.ts

@@ -1,17 +1,17 @@
 import { PrecacheController } from "./PrecacheController.js";
 /**
- * Creates a new, singleton `PrecacheController` if one does not exist. If one does
+ * Creates a new, singleton {@linkcode PrecacheController} if one does not exist. If one does
  * already exist, that instance is returned. This instance is used by Serwist's
- * `PrecacheController`-dependent functions and classes unless you provide a different
- * `Router` to them.
+ * {@linkcode PrecacheController}-dependent functions and classes unless you provide a different
+ * {@linkcode PrecacheController} to them.
  *
- * @returns The singleton `PrecacheController`.
+ * @returns The singleton {@linkcode PrecacheController}.
  * @deprecated
  */
 export declare const getSingletonPrecacheController: () => PrecacheController;
 /**
- * Changes the singleton `PrecacheController` to a different instance. This is meant for when you do not
- * want to pass your own `PrecacheController` to every one of Serwist's `PrecacheController`-dependent
+ * Changes the singleton {@linkcode PrecacheController} to a different instance. This is meant for when you do not
+ * want to pass your own {@linkcode PrecacheController} to every one of Serwist's {@linkcode PrecacheController}-dependent
  * functions and classes.
  *
  * It is highly recommended that you call this before anything else, if you plan on doing so.
@@ -27,7 +27,7 @@ export declare const getSingletonPrecacheController: () => PrecacheController;
  * // Do something with your controller...
  * ```
  * @param router
- * @returns The new singleton `PrecacheController`.
+ * @returns The new singleton {@linkcode PrecacheController}.
  * @deprecated
  */
 export declare const setSingletonPrecacheController: (precacheController: PrecacheController) => PrecacheController;

package/dist/legacy/singletonRouter.d.ts

@@ -1,19 +1,19 @@
 import { Router } from "./Router.js";
 /**
- * Creates a new, singleton `Router` if one does not exist. If one does
+ * Creates a new, singleton {@linkcode Router} if one does not exist. If one does
  * already exist, that instance is returned. This instance is used by
- * Serwist's `Router`-dependent functions and classes unless you provide
- * a different `Router` to them.
+ * Serwist's {@linkcode Router}-dependent functions and classes unless you provide
+ * a different {@linkcode Router} to them.
  *
- * @returns The singleton `Router`.
+ * @returns The singleton {@linkcode Router}.
  * @deprecated
  */
 export declare const getSingletonRouter: () => Router;
 /**
- * Changes the singleton `Router` to a different instance. This is meant for when you do not
- * want to pass your own `Router` to every one of Serwist's `Router`-dependent functions and classes.
- * If this or `getSingletonRouter` has been called before, it removes the listeners of the
- * previous singleton `Router`. It also adds those of the new one, so you need not do that yourself.
+ * Changes the singleton {@linkcode Router} to a different instance. This is meant for when you do not
+ * want to pass your own {@linkcode Router} to every one of Serwist's {@linkcode Router}-dependent functions and classes.
+ * If this or {@linkcode getSingletonRouter} has been called before, it removes the listeners of the
+ * previous singleton {@linkcode Router}. It also adds those of the new one, so you need not do that yourself.
  *
  * It is highly recommended that you call this before anything else, if you plan on doing so.
  *
@@ -34,7 +34,7 @@ export declare const getSingletonRouter: () => Router;
  * );
  * ```
  * @param router
- * @returns The new singleton `Router`.
+ * @returns The new singleton {@linkcode Router}.
  * @deprecated
  */
 export declare const setSingletonRouter: (router: Router) => Router;

package/dist/legacy/unregisterRoute.d.ts

@@ -1,6 +1,6 @@
 import type { Route } from "../Route.js";
 /**
- * Unregisters a route from the singleton `Router` instance.
+ * Unregisters a route from the singleton {@linkcode Router} instance.
  *
  * @param route The route to unregister.
  * @deprecated

package/dist/legacy/unregisterRoute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unregisterRoute.d.ts","sourceRoot":"","sources":["../../src/legacy/unregisterRoute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGzC;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,KAAK,KAAG,IAE9C,CAAC"}
+{"version":3,"file":"unregisterRoute.d.ts","sourceRoot":"","sources":["../../src/legacy/unregisterRoute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAIzC;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,KAAK,KAAG,IAE9C,CAAC"}

package/dist/lib/backgroundSync/BackgroundSyncPlugin.d.ts

@@ -2,14 +2,14 @@ import type { FetchDidFailCallbackParam, SerwistPlugin } from "../../types.js";
 import type { BackgroundSyncQueueOptions } from "./BackgroundSyncQueue.js";
 /**
  * A class implementing the `fetchDidFail` lifecycle callback. This makes it
- * easier to add failed requests to a background sync Queue.
+ * easier to add failed requests to a {@linkcode BackgroundSyncQueue}.
  */
 export declare class BackgroundSyncPlugin implements SerwistPlugin {
     private readonly _queue;
     /**
-     * @param name See the `serwist/plugins.BackgroundSyncQueue`
+     * @param name See the {@linkcode BackgroundSyncQueue}
      * documentation for parameter details.
-     * @param options See the `serwist/plugins.BackgroundSyncQueue`
+     * @param options See the {@linkcode BackgroundSyncQueue}
      * documentation for parameter details.
      * @see https://serwist.pages.dev/docs/core/background-sync-queue
      */

package/dist/lib/backgroundSync/BackgroundSyncQueue.d.ts

@@ -144,7 +144,7 @@ export declare class BackgroundSyncQueue {
     _addRequest({ request, metadata, timestamp }: BackgroundSyncQueueEntry, operation: "push" | "unshift"): Promise<void>;
     /**
      * Removes and returns the first or last (depending on `operation`) entry
-     * from the QueueStore that's not older than the `maxRetentionTime`.
+     * from the {@linkcode BackgroundSyncQueueStore} that's not older than the `maxRetentionTime`.
      *
      * @param operation
      * @returns

package/dist/lib/backgroundSync/StorableRequest.d.ts

@@ -23,7 +23,7 @@ export declare class StorableRequest {
     static fromRequest(request: Request): Promise<StorableRequest>;
     /**
      * Accepts an object of request data that can be used to construct a
-     * `Request` but can also be stored in IndexedDB.
+     * `Request` object but can also be stored in IndexedDB.
      *
      * @param requestData An object of request data that includes the `url` plus any relevant property of
      * [`requestInit`](https://fetch.spec.whatwg.org/#requestinit).

package/dist/lib/broadcastUpdate/BroadcastCacheUpdate.d.ts

@@ -12,8 +12,7 @@ export declare class BroadcastCacheUpdate {
     private readonly _generatePayload;
     private readonly _notifyAllClients;
     /**
-     * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
-     * broadcast messages on
+     * Construct an instance of `BroadcastCacheUpdate`.
      *
      * @param options
      */

package/dist/lib/broadcastUpdate/BroadcastCacheUpdate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BroadcastCacheUpdate.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/BroadcastCacheUpdate.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAYlE,OAAO,KAAK,EAAE,2BAA2B,EAAiE,MAAM,YAAY,CAAC;AAuB7H;;;;;;GAMG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4B;IAC7D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAE5C;;;;;OAKG;gBACS,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAE,2BAAgC;IAMnG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E"}
+{"version":3,"file":"BroadcastCacheUpdate.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/BroadcastCacheUpdate.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAYlE,OAAO,KAAK,EAAE,2BAA2B,EAAiE,MAAM,YAAY,CAAC;AAuB7H;;;;;;GAMG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4B;IAC7D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAE5C;;;;OAIG;gBACS,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAE,2BAAgC;IAMnG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E"}

package/dist/lib/broadcastUpdate/BroadcastUpdatePlugin.d.ts

@@ -7,18 +7,15 @@ import type { BroadcastCacheUpdateOptions } from "./types.js";
 export declare class BroadcastUpdatePlugin implements SerwistPlugin {
     private readonly _broadcastUpdate;
     /**
-     * Construct a `serwist.BroadcastCacheUpdate` instance with
-     * the passed options and calls its `notifyIfUpdated` method whenever the
-     * plugin's `cacheDidUpdate` callback is invoked.
+     * Construct a {@linkcode BroadcastCacheUpdate} instance with
+     * the passed options and calls its {@linkcode BroadcastCacheUpdate.notifyIfUpdated}
+     * method whenever the plugin's {@linkcode BroadcastUpdatePlugin.cacheDidUpdate} callback
+     * is invoked.
      *
      * @param options
      */
     constructor(options?: BroadcastCacheUpdateOptions);
     /**
-     * A "lifecycle" callback that will be triggered automatically by
-     * `@serwist/build.RuntimeCaching` handlers when an entry is
-     * added to a cache.
-     *
      * @private
      * @param options The input object to this function.
      */

package/dist/lib/broadcastUpdate/BroadcastUpdatePlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BroadcastUpdatePlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/BroadcastUpdatePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAE9D;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,aAAa;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IAExD;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE,2BAA2B;IAIjD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,2BAA2B;CAGpD"}
+{"version":3,"file":"BroadcastUpdatePlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/BroadcastUpdatePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAE9D;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,aAAa;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IAExD;;;;;;;OAOG;gBACS,OAAO,CAAC,EAAE,2BAA2B;IAIjD;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,2BAA2B;CAGpD"}

package/dist/lib/broadcastUpdate/types.d.ts

@@ -5,7 +5,8 @@ export interface BroadcastCacheUpdateOptions {
      * A list of headers that will be used to determine whether the responses
      * differ.
      *
-     * @default ['content-length', 'etag', 'last-modified']
+     * @default
+     * ['content-length', 'etag', 'last-modified']`
      */
     headersToCheck?: string[];
     /**

package/dist/lib/broadcastUpdate/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,6BAA6B,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAEnG,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,2BAA2B,KAAK,gBAAgB,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC;CAC3B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/broadcastUpdate/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,6BAA6B,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAEnG,MAAM,WAAW,2BAA2B;IAC1C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,2BAA2B,KAAK,gBAAgB,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC;CAC3B"}

package/dist/lib/cacheableResponse/CacheableResponse.d.ts

@@ -1,28 +1,28 @@
 export interface CacheableResponseOptions {
     /**
-     * One or more status codes that a `Response` can have to be considered cacheable.
+     * One or more HTTP status codes that a response can have to be considered cacheable.
      */
     statuses?: number[];
     /**
-     * A mapping of header names and expected values that a `Response` can have and be
+     * A mapping of header names and expected values that a response can have and be
      * considered cacheable. If multiple headers are provided, only one needs to be present.
      */
     headers?: HeadersInit;
 }
 /**
  * Allows you to set up rules determining what status codes and/or headers need
- * to be present in order for a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * to be present in order for a [response](https://developer.mozilla.org/en-US/docs/Web/API/Response)
  * to be considered cacheable.
  */
 export declare class CacheableResponse {
     private readonly _statuses?;
     private readonly _headers?;
     /**
-     * To construct a new CacheableResponse instance you must provide at least
+     * To construct a new `CacheableResponse` instance you must provide at least
      * one of the `config` properties.
      *
      * If both `statuses` and `headers` are specified, then both conditions must
-     * be met for the `Response` to be considered cacheable.
+     * be met for the response to be considered cacheable.
      *
      * @param config
      */
@@ -32,7 +32,7 @@ export declare class CacheableResponse {
      *
      * @param response The response whose cacheability is being
      * checked.
-     * @returns `true` if the `Response` is cacheable, and `false`
+     * @returns `true` if the response is cacheable, and `false`
      * otherwise.
      */
     isResponseCacheable(response: Response): boolean;

package/dist/lib/cacheableResponse/CacheableResponsePlugin.d.ts

@@ -8,11 +8,11 @@ import type { CacheableResponseOptions } from "./CacheableResponse.js";
 export declare class CacheableResponsePlugin implements SerwistPlugin {
     private readonly _cacheableResponse;
     /**
-     * To construct a new CacheableResponsePlugin instance you must provide at
+     * To construct a new `CacheableResponsePlugin` instance you must provide at
      * least one of the `config` properties.
      *
      * If both `statuses` and `headers` are specified, then both conditions must
-     * be met for the `Response` to be considered cacheable.
+     * be met for the response to be considered cacheable.
      *
      * @param config
      */

package/dist/lib/expiration/CacheExpiration.d.ts

@@ -1,6 +1,6 @@
 interface CacheExpirationConfig {
     /**
-     * The maximum number of entries to cache. Entries used the least will
+     * The maximum number of entries to cache. Entries used least recently will
      * be removed as the maximum is reached.
      */
     maxEntries?: number;
@@ -27,7 +27,7 @@ export declare class CacheExpiration {
     private readonly _cacheName;
     private readonly _timestampModel;
     /**
-     * To construct a new CacheExpiration instance you must provide at least
+     * To construct a new `CacheExpiration` instance you must provide at least
      * one of the `config` properties.
      *
      * @param cacheName Name of the cache to apply restrictions to.

package/dist/lib/expiration/ExpirationPlugin.d.ts

@@ -1,8 +1,9 @@
 import type { CacheDidUpdateCallbackParam, CachedResponseWillBeUsedCallbackParam, SerwistPlugin } from "../../types.js";
 export interface ExpirationPluginOptions {
     /**
-     * The maximum number of entries to cache. Entries used the least will be removed
-     * as the maximum is reached.
+     * The maximum number of entries to cache. Entries used (if `maxAgeFrom` is
+     * `"last-used"`) or fetched from the network (if `maxAgeFrom` is `"last-fetched"`)
+     * least recently will be removed as the maximum is reached.
      */
     maxEntries?: number;
     /**
@@ -27,10 +28,10 @@ export interface ExpirationPluginOptions {
     purgeOnQuotaError?: boolean;
 }
 /**
- * This plugin can be used in a `serwist/strategies` Strategy to regularly enforce a
+ * This plugin can be used in a {@linkcode Strategy} to regularly enforce a
  * limit on the age and/or the number of cached requests.
  *
- * It can only be used with Strategy instances that have a custom `cacheName` property set.
+ * It can only be used with {@linkcode Strategy} instances that have a custom `cacheName` property set.
  * In other words, it can't be used to expire entries in strategies that use the default runtime
  * cache name.
  *
@@ -64,11 +65,10 @@ export declare class ExpirationPlugin implements SerwistPlugin {
      */
     private _getCacheExpiration;
     /**
-     * A "lifecycle" callback that will be triggered automatically by the
-     * `serwist/strategies` handlers when a `Response` is about to be returned
-     * from a [Cache](https://developer.mozilla.org/en-US/docs/Web/API/Cache) to
-     * the handler. It allows the `Response` to be inspected for freshness and
-     * prevents it from being used if the `Response`'s `Date` header value is
+     * A lifecycle callback that will be triggered automatically when a
+     * response is about to be returned from a [`Cache`](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
+     * It allows the response to be inspected for freshness and
+     * prevents it from being used if the response's `Date` header value is
      * older than the configured `maxAgeSeconds`.
      *
      * @param options
@@ -92,8 +92,8 @@ export declare class ExpirationPlugin implements SerwistPlugin {
      */
     private _getDateHeaderTimestamp;
     /**
-     * A "lifecycle" callback that will be triggered automatically by the
-     * `serwist/strategies` handlers when an entry is added to a cache.
+     * A lifecycle callback that will be triggered automatically when an entry is added
+     * to a cache.
      *
      * @param options
      * @private

package/dist/lib/expiration/ExpirationPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpirationPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/expiration/ExpirationPlugin.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,2BAA2B,EAAE,qCAAqC,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAQxH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC;IAC1C;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAiB,YAAW,aAAa;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,iBAAiB,CAA+B;IAExD;;OAEG;gBACS,MAAM,GAAE,uBAA4B;IAkDhD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,qCAAqC;IAqC7G;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAwB5B;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,2BAA2B;IAqBxE;;;;;;;;;;;OAWG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAW9C"}
+{"version":3,"file":"ExpirationPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/expiration/ExpirationPlugin.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,2BAA2B,EAAE,qCAAqC,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AASxH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC;IAC1C;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAiB,YAAW,aAAa;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,iBAAiB,CAA+B;IAExD;;OAEG;gBACS,MAAM,GAAE,uBAA4B;IAkDhD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,qCAAqC;IAqC7G;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAwB5B;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,2BAA2B;IAqBxE;;;;;;;;;;;OAWG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAW9C"}

package/dist/lib/precaching/PrecacheFallbackPlugin.d.ts

@@ -18,13 +18,13 @@ export interface PrecacheFallbackPluginOptions {
      */
     fallbackUrls: (string | PrecacheFallbackEntry)[];
     /**
-     * Your `Serwist` instance.
+     * A {@linkcode Serwist} instance.
      */
     serwist: Serwist;
 }
 /**
- * `PrecacheFallbackPlugin` allows you to specify offline fallbacks
- * to be used when a given strategy is unable to generate a response.
+ * Allows you to specify offline fallbacks to be used when a given strategy
+ * is unable to generate a response.
  *
  * It does this by intercepting the `handlerDidError` plugin callback
  * and returning a precached response, taking the expected revision parameter
@@ -34,7 +34,7 @@ export declare class PrecacheFallbackPlugin implements SerwistPlugin {
     private readonly _fallbackUrls;
     private readonly _serwist;
     /**
-     * Constructs a new `PrecacheFallbackPlugin` with the associated `fallbackUrls`.
+     * Constructs a new instance with the associated `fallbackUrls`.
      *
      * @param config
      */

package/dist/lib/rangeRequests/RangeRequestsPlugin.d.ts

@@ -1,7 +1,6 @@
 import type { SerwistPlugin } from "../../types.js";
 /**
- * The range request plugin makes it easy for a request with a 'Range' header to
- * be fulfilled by a cached response.
+ * Makes it easy for a request with a `Range` header to be fulfilled by a cached response.
  *
  * It does this by intercepting the `cachedResponseWillBeUsed` plugin callback
  * and returning the appropriate subset of the cached response body.
@@ -9,8 +8,8 @@ import type { SerwistPlugin } from "../../types.js";
 export declare class RangeRequestsPlugin implements SerwistPlugin {
     /**
      * @param options
-     * @returns If request contains a 'Range' header, then a
-     * new response with status 206 whose body is a subset of `cachedResponse` is
+     * @returns If request contains a `Range` header, then a
+     * partial response whose body is a subset of `cachedResponse` is
      * returned. Otherwise, `cachedResponse` is returned as-is.
      * @private
      */

package/dist/lib/rangeRequests/RangeRequestsPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RangeRequestsPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/rangeRequests/RangeRequestsPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;;;;GAMG;AACH,qBAAa,mBAAoB,YAAW,aAAa;IACvD;;;;;;OAMG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAUjE;CACH"}
+{"version":3,"file":"RangeRequestsPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/rangeRequests/RangeRequestsPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,aAAa;IACvD;;;;;;OAMG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAUjE;CACH"}

package/dist/lib/rangeRequests/createPartialResponse.d.ts

@@ -1,18 +1,18 @@
 /**
- * Given a `Request` and `Response` objects as input, this will return a
- * promise for a new `Response`.
+ * Given a request and a response, this will return a
+ * promise that resolves to a partial response.
  *
- * If the original `Response` already contains partial content (i.e. it has
- * a status of 206), then this assumes it already fulfills the `Range:`
+ * If the original response already contains partial content (i.e. it has
+ * a status of 206), then this assumes it already fulfills the `Range`
  * requirements, and will return it as-is.
  *
- * @param request A request, which should contain a Range:
+ * @param request A request, which should contain a `Range`
  * header.
  * @param originalResponse A response.
  * @returns Either a `206 Partial Content` response, with
  * the response body set to the slice of content specified by the request's
- * `Range:` header, or a `416 Range Not Satisfiable` response if the
- * conditions of the `Range:` header can't be met.
+ * `Range` header, or a `416 Range Not Satisfiable` response if the
+ * conditions of the `Range` header can't be met.
  */
 export declare const createPartialResponse: (request: Request, originalResponse: Response) => Promise<Response>;
 //# sourceMappingURL=createPartialResponse.d.ts.map

package/dist/lib/rangeRequests/createPartialResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createPartialResponse.d.ts","sourceRoot":"","sources":["../../../src/lib/rangeRequests/createPartialResponse.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,YAAmB,OAAO,oBAAoB,QAAQ,KAAG,QAAQ,QAAQ,CA8D1G,CAAC"}
+{"version":3,"file":"createPartialResponse.d.ts","sourceRoot":"","sources":["../../../src/lib/rangeRequests/createPartialResponse.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,YAAmB,OAAO,oBAAoB,QAAQ,KAAG,OAAO,CAAC,QAAQ,CA8D1G,CAAC"}

package/dist/lib/rangeRequests/utils/parseRangeHeader.d.ts

@@ -1,7 +1,7 @@
 /**
- * @param rangeHeader A Range: header value.
+ * @param rangeHeader A `Range` header value.
  * @returns An object with `start` and `end` properties, reflecting
- * the parsed value of the Range: header. If either the `start` or `end` are
+ * the parsed value of the `Range` header. If either the `start` or `end` are
  * omitted, then `null` will be returned.
  * @private
  */

package/dist/lib/strategies/CacheFirst.d.ts

@@ -9,7 +9,7 @@ import type { StrategyHandler } from "./StrategyHandler.js";
  * can be cached for long periods of time.
  *
  * If the network request fails, and there is no cache match, this will throw
- * a `SerwistError` exception.
+ * a {@linkcode SerwistError} exception.
  */
 export declare class CacheFirst extends Strategy {
     /**

package/dist/lib/strategies/CacheOnly.d.ts

@@ -6,7 +6,7 @@ import type { StrategyHandler } from "./StrategyHandler.js";
  *
  * This class is useful if you already have your own precaching step.
  *
- * If there is no cache match, this will throw a `SerwistError` exception.
+ * If there is no cache match, this will throw a {@linkcode SerwistError} exception.
  */
 export declare class CacheOnly extends Strategy {
     /**

package/dist/lib/strategies/NetworkFirst.d.ts

@@ -17,7 +17,7 @@ export interface NetworkFirstOptions extends StrategyOptions {
  * support [CORS](https://enable-cors.org/).
  *
  * If the network request fails, and there is no cache match, this will throw
- * a `SerwistError` exception.
+ * a {@linkcode SerwistError} exception.
  */
 export declare class NetworkFirst extends Strategy {
     private readonly _networkTimeoutSeconds;

package/dist/lib/strategies/NetworkOnly.d.ts

@@ -13,7 +13,7 @@ export interface NetworkOnlyOptions extends Omit<StrategyOptions, "cacheName" |
  *
  * This class is useful if you require specific requests to only be fulfilled from the network.
  *
- * If the network request fails, this will throw a `SerwistError` exception.
+ * If the network request fails, this will throw a {@linkcode SerwistError} exception.
  */
 export declare class NetworkOnly extends Strategy {
     private readonly _networkTimeoutSeconds;

package/dist/lib/strategies/PrecacheStrategy.d.ts

@@ -10,11 +10,11 @@ interface PrecacheStrategyOptions extends StrategyOptions {
     fallbackToNetwork?: boolean;
 }
 /**
- * A `serwist/strategies.Strategy` implementation
- * specifically designed to both cache and fetch precached assets.
+ * A {@linkcode Strategy} implementation specifically designed to both cache
+ * and fetch precached assets.
  *
  * Note: an instance of this class is created automatically when creating a
- * `Serwist` instance; it's generally not necessary to create this yourself.
+ * {@linkcode Serwist} instance; it's generally not necessary to create this yourself.
  */
 export declare class PrecacheStrategy extends Strategy {
     private readonly _fallbackToNetwork;

package/dist/lib/strategies/PrecacheStrategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrecacheStrategy.d.ts","sourceRoot":"","sources":["../../../src/lib/strategies/PrecacheStrategy.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAKpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,UAAU,uBAAwB,SAAQ,eAAe;IACvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAE7C,MAAM,CAAC,QAAQ,CAAC,iCAAiC,EAAE,aAAa,CAQ9D;IAEF,MAAM,CAAC,QAAQ,CAAC,sCAAsC,EAAE,aAAa,CAInE;IAEF;;OAEG;gBACS,OAAO,GAAE,uBAA4B;IAcjD;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkBtE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyE3E,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAqBnF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,qCAAqC,IAAI,IAAI;CA4B9C"}
+{"version":3,"file":"PrecacheStrategy.d.ts","sourceRoot":"","sources":["../../../src/lib/strategies/PrecacheStrategy.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAMpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,UAAU,uBAAwB,SAAQ,eAAe;IACvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAE7C,MAAM,CAAC,QAAQ,CAAC,iCAAiC,EAAE,aAAa,CAQ9D;IAEF,MAAM,CAAC,QAAQ,CAAC,sCAAsC,EAAE,aAAa,CAInE;IAEF;;OAEG;gBACS,OAAO,GAAE,uBAA4B;IAcjD;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkBtE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyE3E,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAqBnF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,qCAAqC,IAAI,IAAI;CA4B9C"}

package/dist/lib/strategies/StaleWhileRevalidate.d.ts

@@ -17,7 +17,7 @@ import type { StrategyHandler } from "./StrategyHandler.js";
  * support [CORS](https://enable-cors.org/).
  *
  * If the network request fails, and there is no cache match, this will throw
- * a `SerwistError` exception.
+ * a {@linkcode SerwistError} exception.
  */
 export declare class StaleWhileRevalidate extends Strategy {
     /**

package/dist/lib/strategies/Strategy.d.ts

@@ -44,13 +44,13 @@ export declare abstract class Strategy implements RouteHandlerObject {
      */
     constructor(options?: StrategyOptions);
     /**
-     * Performs a request strategy and returns a `Promise` that will resolve with
-     * a `Response`, invoking all relevant plugin callbacks.
+     * Performs a request strategy and returns a promise that will resolve to
+     * a response, invoking all relevant plugin callbacks.
      *
-     * When a strategy instance is registered with a `Route`, this method is automatically
+     * When a strategy instance is registered with a route, this method is automatically
      * called when the route matches.
      *
-     * Alternatively, this method can be used in a standalone `FetchEvent`
+     * Alternatively, this method can be used in a standalone `fetch` event
      * listener by passing it to `event.respondWith()`.
      *
      * @param options A `FetchEvent` or an object with the properties listed below.
@@ -61,10 +61,10 @@ export declare abstract class Strategy implements RouteHandlerObject {
      */
     handle(options: FetchEvent | HandlerCallbackOptions): Promise<Response>;
     /**
-     * Similar to `handle()`, but instead of just returning a `Promise` that
-     * resolves to a `Response`, it will return an tuple of `[response, done]` promises,
+     * Similar to `handle()`, but instead of just returning a promise that
+     * resolves to a response, it will return an tuple of `[response, done]` promises,
      * where `response` is equivalent to what `handle()` returns, and `done` is a
-     * `Promise` that will resolve once all promises added to `event.waitUntil()` as a part
+     * promise that will resolve once all promises added to `event.waitUntil()` as a part
      * of performing the strategy have completed.
      *
      * You can await the `done` promise to ensure any extra work performed by