serwist/src/legacy/setDefaultHandler.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 { RouteHandler } from "../types.js";
import { getSingletonRouter } from "./singletonRouter.js";

/**
 * 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
 * network as if there were no service worker present.
 *
 * @param handler A callback function that returns a promise resulting in a response.
 * @deprecated
 */
export const setDefaultHandler = (handler: RouteHandler): void => {
  getSingletonRouter().setDefaultHandler(handler);
};