serwist/dist/legacy/PrecacheFallbackPlugin.d.ts

A Swiss Army knife for service workers.

import type { HandlerDidErrorCallbackParam, SerwistPlugin } from "../types.js";
import type { PrecacheController } from "./PrecacheController.js";
/**
 * @deprecated
 */
export interface PrecacheFallbackEntry {
    /**
     * A function that checks whether the fallback entry can be used
     * for a request.
     */
    matcher: (param: HandlerDidErrorCallbackParam) => boolean;
    /**
     * A precached URL to be used as a fallback.
     */
    url: string;
}
/**
 * @deprecated
 */
export interface PrecacheFallbackPluginOptions {
    /**
     * Precached URLs to be used as the fallback
     * if the associated strategy can't generate a response.
     */
    fallbackUrls: (string | PrecacheFallbackEntry)[];
    /**
     * An optional {@linkcode PrecacheController} instance. If not provided,
     * the default {@linkcode PrecacheController} will be used.
     */
    precacheController?: PrecacheController;
}
/**
 * A class that 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
 * into account automatically.
 *
 * Unless you explicitly pass in a {@linkcode PrecacheController} instance to the
 * constructor, the default instance will be used.
 *
 * @deprecated
 */
export declare class PrecacheFallbackPlugin implements SerwistPlugin {
    private readonly _fallbackUrls;
    private readonly _precacheController;
    /**
     * Constructs a new instance with the associated `fallbackUrls`.
     *
     * @param config
     */
    constructor({ fallbackUrls, precacheController }: PrecacheFallbackPluginOptions);
    /**
     * @returns The precache response for one of the fallback URLs, or `undefined` if
     * nothing satisfies the conditions.
     * @private
     */
    handlerDidError(param: HandlerDidErrorCallbackParam): Promise<Response | undefined>;
}
//# sourceMappingURL=PrecacheFallbackPlugin.d.ts.map