registerRoute.d.ts
1.15 KB
import { Route } from './Route.js';
import { HTTPMethod } from './utils/constants.js';
import { Handler, MatchCallback } from './_types.js';
import './_version.js';
/**
* Easily register a RegExp, string, or function with a caching
* strategy to a singleton Router instance.
*
* This method will generate a Route for you if needed and
* call [registerRoute()]{@link module:workbox-routing.Router#registerRoute}.
*
* @param {RegExp|string|module:workbox-routing.Route~matchCallback|module:workbox-routing.Route} capture
* If the capture param is a `Route`, all other arguments will be ignored.
* @param {module:workbox-routing~handlerCallback} [handler] A callback
* function that returns a Promise resulting in a Response. This parameter
* is required if `capture` is not a `Route` object.
* @param {string} [method='GET'] The HTTP method to match the Route
* against.
* @return {module:workbox-routing.Route} The generated `Route`(Useful for
* unregistering).
*
* @memberof module:workbox-routing
*/
declare function registerRoute(capture: RegExp | string | MatchCallback | Route, handler?: Handler, method?: HTTPMethod): Route;
export { registerRoute };