123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- /*
- Copyright 2018 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 {assert} from 'workbox-core/_private/assert.js';
- import {HTTPMethod, defaultMethod, validMethods} from './utils/constants.js';
- import {normalizeHandler} from './utils/normalizeHandler.js';
- import {Handler, HandlerObject, MatchCallback} from './_types.js';
- import './_version.js';
- /**
- * A `Route` consists of a pair of callback functions, "match" and "handler".
- * The "match" callback determine if a route should be used to "handle" a
- * request by returning a non-falsy value if it can. The "handler" callback
- * is called when there is a match and should return a Promise that resolves
- * to a `Response`.
- *
- * @memberof module:workbox-routing
- */
- class Route {
- handler: HandlerObject;
- match: MatchCallback;
- method: HTTPMethod;
- /**
- * Constructor for Route class.
- *
- * @param {module:workbox-routing~matchCallback} match
- * A callback function that determines whether the route matches a given
- * `fetch` event by returning a non-falsy value.
- * @param {module:workbox-routing~handlerCallback} handler A callback
- * function that returns a Promise resolving to a Response.
- * @param {string} [method='GET'] The HTTP method to match the Route
- * against.
- */
- constructor(
- match: MatchCallback,
- handler: Handler,
- method: HTTPMethod = defaultMethod) {
- if (process.env.NODE_ENV !== 'production') {
- assert!.isType(match, 'function', {
- moduleName: 'workbox-routing',
- className: 'Route',
- funcName: 'constructor',
- paramName: 'match',
- });
- if (method) {
- assert!.isOneOf(method, validMethods, {paramName: 'method'});
- }
- }
- // These values are referenced directly by Router so cannot be
- // altered by minificaton.
- this.handler = normalizeHandler(handler);
- this.match = match;
- this.method = method;
- }
- }
- export {Route};
|