serwist/src/legacy/precache.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 { PrecacheEntry } from "../types.js";
import type { addRoute } from "./addRoute.js";
import type { precacheAndRoute } from "./precacheAndRoute.js";
import { getSingletonPrecacheController } from "./singletonPrecacheController.js";

/**
 * Adds items to the precache list, removing any duplicates and
 * stores the files in the precache cache when the service
 * worker installs.
 *
 * This method can be called multiple times.
 *
 * Please note: This method **will not** serve any of the cached files for you.
 * It only precaches files. To respond to a network request you call
 * {@linkcode addRoute}.
 *
 * If you have a single array of files to precache, you can just call
 * {@linkcode precacheAndRoute}.
 *
 * @param entries Array of entries to precache.
 * @deprecated
 */
export const precache = (entries: (PrecacheEntry | string)[]): void => {
  getSingletonPrecacheController().precache(entries);
};