58 lines
1.9 KiB
JavaScript
58 lines
1.9 KiB
JavaScript
/*
|
|
Copyright 2016 Google Inc. All Rights Reserved.
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import {CacheableResponse} from './CacheableResponse.mjs';
|
|
import './_version.mjs';
|
|
|
|
/**
|
|
* A class implementing the `cacheWillUpdate` lifecycle callback. This makes it
|
|
* easier to add in cacheability checks to requests made via Workbox's built-in
|
|
* strategies.
|
|
*
|
|
* @memberof workbox.cacheableResponse
|
|
*/
|
|
class Plugin {
|
|
/**
|
|
* To construct a new cacheable response Plugin instance you must provide at
|
|
* least one of the `config` properties.
|
|
*
|
|
* If both `statuses` and `headers` are specified, then both conditions must
|
|
* be met for the `Response` to be considered cacheable.
|
|
*
|
|
* @param {Object} config
|
|
* @param {Array<number>} [config.statuses] One or more status codes that a
|
|
* `Response` can have and be considered cacheable.
|
|
* @param {Object<string,string>} [config.headers] A mapping of header names
|
|
* and expected values that a `Response` can have and be considered cacheable.
|
|
* If multiple headers are provided, only one needs to be present.
|
|
*/
|
|
constructor(config) {
|
|
this._cacheableResponse = new CacheableResponse(config);
|
|
}
|
|
|
|
/**
|
|
* @param {Object} options
|
|
* @param {Response} options.response
|
|
* @return {boolean}
|
|
* @private
|
|
*/
|
|
cacheWillUpdate({response}) {
|
|
if (this._cacheableResponse.isResponseCacheable(response)) {
|
|
return response;
|
|
}
|
|
return null;
|
|
}
|
|
}
|
|
|
|
export {Plugin};
|