mirror of
https://github.com/idanoo/GoScrobble.git
synced 2024-11-22 16:35:14 +00:00
63 lines
2.6 KiB
TypeScript
63 lines
2.6 KiB
TypeScript
import { RouteHandlerObject, RouteHandlerCallbackOptions, WorkboxPlugin } from 'workbox-core/types.js';
|
|
import './_version.js';
|
|
interface CacheFirstOptions {
|
|
cacheName?: string;
|
|
plugins?: WorkboxPlugin[];
|
|
fetchOptions?: RequestInit;
|
|
matchOptions?: CacheQueryOptions;
|
|
}
|
|
/**
|
|
* An implementation of a [cache-first]{@link https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/#cache-falling-back-to-network}
|
|
* request strategy.
|
|
*
|
|
* A cache first strategy is useful for assets that have been revisioned,
|
|
* such as URLs like `/styles/example.a8f5f1.css`, since they
|
|
* can be cached for long periods of time.
|
|
*
|
|
* If the network request fails, and there is no cache match, this will throw
|
|
* a `WorkboxError` exception.
|
|
*
|
|
* @memberof module:workbox-strategies
|
|
*/
|
|
declare class CacheFirst implements RouteHandlerObject {
|
|
private readonly _cacheName;
|
|
private readonly _plugins;
|
|
private readonly _fetchOptions?;
|
|
private readonly _matchOptions?;
|
|
/**
|
|
* @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)
|
|
*/
|
|
constructor(options?: CacheFirstOptions);
|
|
/**
|
|
* 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>;
|
|
/**
|
|
* Handles the network and cache part of CacheFirst.
|
|
*
|
|
* @param {Request} request
|
|
* @param {Event} [event]
|
|
* @return {Promise<Response>}
|
|
*
|
|
* @private
|
|
*/
|
|
_getFromNetwork(request: Request, event?: ExtendableEvent): Promise<any>;
|
|
}
|
|
export { CacheFirst };
|