serwist/src/legacy/addRoute.ts

A Swiss Army knife for service workers.

/*
  Copyright 2019 Google LLC
  Use of this source code is governed by an MIT-style
  license that can be found in the LICENSE file or at
  https://opensource.org/licenses/MIT.
*/

import type { PrecacheRouteOptions } from "../types.js";
import { PrecacheRoute } from "./PrecacheRoute.js";
import { registerRoute } from "./registerRoute.js";
import { getSingletonPrecacheController } from "./singletonPrecacheController.js";

/**
 * Add a `fetch` listener that will
 * respond to [network requests](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers#Custom_responses_to_requests)
 * with precached assets to the service worker.
 *
 * As for requests for assets that aren't precached, the `fetch` event will not be
 * responded to, allowing the event to fall through to other `fetch` event listeners.
 *
 * @param options See {@linkcode PrecacheRouteOptions}.
 * @deprecated
 */
export const addRoute = (options?: PrecacheRouteOptions): void => {
  const precacheRoute = new PrecacheRoute(getSingletonPrecacheController(), options);
  registerRoute(precacheRoute);
};