123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- import { RouteHandlerObject, RouteHandlerCallbackOptions, WorkboxPlugin } from 'workbox-core/types.js';
- import './_version.js';
- interface NetworkFirstOptions {
- cacheName?: string;
- plugins?: WorkboxPlugin[];
- fetchOptions?: RequestInit;
- matchOptions?: CacheQueryOptions;
- networkTimeoutSeconds?: number;
- }
- /**
- * An implementation of a
- * [network first]{@link https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/#network-falling-back-to-cache}
- * request strategy.
- *
- * By default, this strategy will cache responses with a 200 status code as
- * well as [opaque responses]{@link https://developers.google.com/web/tools/workbox/guides/handle-third-party-requests}.
- * Opaque responses are are cross-origin requests where the response doesn't
- * support [CORS]{@link https://enable-cors.org/}.
- *
- * If the network request fails, and there is no cache match, this will throw
- * a `WorkboxError` exception.
- *
- * @memberof module:workbox-strategies
- */
- declare class NetworkFirst implements RouteHandlerObject {
- private readonly _cacheName;
- private readonly _plugins;
- private readonly _fetchOptions?;
- private readonly _matchOptions?;
- private readonly _networkTimeoutSeconds;
- /**
- * @param {Object} options
- * @param {string} options.cacheName Cache name to store and retrieve
- * requests. Defaults to cache names provided by
- * [workbox-core]{@link module:workbox-core.cacheNames}.
- * @param {Array<Object>} options.plugins [Plugins]{@link https://developers.google.com/web/tools/workbox/guides/using-plugins}
- * to use in conjunction with this caching strategy.
- * @param {Object} options.fetchOptions Values passed along to the
- * [`init`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Parameters)
- * of all fetch() requests made by this strategy.
- * @param {Object} options.matchOptions [`CacheQueryOptions`](https://w3c.github.io/ServiceWorker/#dictdef-cachequeryoptions)
- * @param {number} options.networkTimeoutSeconds If set, any network requests
- * that fail to respond within the timeout will fallback to the cache.
- *
- * This option can be used to combat
- * "[lie-fi]{@link https://developers.google.com/web/fundamentals/performance/poor-connectivity/#lie-fi}"
- * scenarios.
- */
- constructor(options?: NetworkFirstOptions);
- /**
- * This method will perform a request strategy and follows an API that
- * will work with the
- * [Workbox Router]{@link module:workbox-routing.Router}.
- *
- * @param {Object} options
- * @param {Request|string} options.request A request to run this strategy for.
- * @param {Event} [options.event] The event that triggered the request.
- * @return {Promise<Response>}
- */
- handle({ event, request }: RouteHandlerCallbackOptions): Promise<Response>;
- /**
- * @param {Object} options
- * @param {Request} options.request
- * @param {Array} options.logs A reference to the logs array
- * @param {Event} [options.event]
- * @return {Promise<Response>}
- *
- * @private
- */
- private _getTimeoutPromise;
- /**
- * @param {Object} options
- * @param {number|undefined} options.timeoutId
- * @param {Request} options.request
- * @param {Array} options.logs A reference to the logs Array.
- * @param {Event} [options.event]
- * @return {Promise<Response>}
- *
- * @private
- */
- _getNetworkPromise({ timeoutId, request, logs, event }: {
- request: Request;
- logs: any[];
- timeoutId?: number;
- event?: ExtendableEvent;
- }): Promise<Response>;
- /**
- * Used if the network timeouts or fails to make the request.
- *
- * @param {Object} options
- * @param {Request} request The request to match in the cache
- * @param {Event} [options.event]
- * @return {Promise<Object>}
- *
- * @private
- */
- private _respondFromCache;
- }
- export { NetworkFirst };
|