serwist/dist/legacy/handlePrecaching.d.ts

A Swiss Army knife for service workers.

import type { PrecacheEntry, PrecacheRouteOptions } from "../types.js";
import type { PrecacheController } from "./PrecacheController.js";
import type { Router } from "./Router.js";
/**
 * @deprecated
 */
export interface HandlePrecachingOptions {
    /**
     * An optional {@linkcode PrecacheController} instance. If not provided, the singleton
     * {@linkcode PrecacheController} will be used.
     */
    precacheController?: PrecacheController;
    /**
     * An optional {@linkcode Router} instance. If not provided, the singleton {@linkcode Router}
     * will be used.
     */
    router?: Router;
    /**
     * A list of URLs that should be cached.
     */
    precacheEntries?: (PrecacheEntry | string)[];
    /**
     * Options to customize how Serwist precaches the URLs.
     */
    precacheOptions?: PrecacheRouteOptions;
    /**
     * Whether outdated caches should be removed.
     *
     * @default false
     */
    cleanupOutdatedCaches?: boolean;
    /**
     * An URL that should point to a HTML file with which navigation requests for URLs that aren't
     * precached will be fulfilled.
     */
    navigateFallback?: string;
    /**
     * URLs that should be allowed to use the `navigateFallback` handler.
     */
    navigateFallbackAllowlist?: RegExp[];
    /**
     * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
     * over `navigateFallbackAllowlist`.
     */
    navigateFallbackDenylist?: RegExp[];
}
/**
 * Handles a list of precache entries and cleans up outdated caches.
 *
 * @param options
 * @deprecated
 */
export declare const handlePrecaching: ({ precacheController, router, precacheEntries, precacheOptions, cleanupOutdatedCaches, navigateFallback, navigateFallbackAllowlist, navigateFallbackDenylist, }: HandlePrecachingOptions) => void;
//# sourceMappingURL=handlePrecaching.d.ts.map