https://github.com/wqteam/jquery-ajax-cache
A jQuery plugin, for cache the AJAX with 'localStorage' or 'sessionStorage'.
https://github.com/wqteam/jquery-ajax-cache
ajax localstorage sessionstorage
Last synced: about 1 month ago
JSON representation
A jQuery plugin, for cache the AJAX with 'localStorage' or 'sessionStorage'.
- Host: GitHub
- URL: https://github.com/wqteam/jquery-ajax-cache
- Owner: WQTeam
- License: mit
- Created: 2015-10-08T05:05:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T01:11:52.000Z (about 8 years ago)
- Last Synced: 2026-01-24T04:48:53.231Z (about 2 months ago)
- Topics: ajax, localstorage, sessionstorage
- Language: JavaScript
- Homepage:
- Size: 161 KB
- Stars: 56
- Watchers: 12
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jquery-ajax-cache
[](https://travis-ci.org/WQTeam/jquery-ajax-cache)
[](https://www.npmjs.com/package/jquery-ajax-cache)
## Language
[English Document](./README_EN.md)
jquery-ajax-cache 插件扩展了jQuery的`$.ajax`，提供非常便利的方式缓存ajax请求到‘localStorage’或‘sessionStorage’中。你唯一要做的就是实现`cacheValidate`方法，验证返回结果是否需要缓存。页面加载和数据读写过程插件都会进行过期数据清除，避免过期数据的堆积。同时你也可以调用`$ajaxCache.deleteAllExpires()`手动清除过期缓存。
# Why jquery-ajax-cache？
### 优点
1、使用简单！
2、还是使用简单！！
3、重要事情3遍，简单！！！
4、最大可能的清除过期数据，避免溢出
# 下载
[下载](https://github.com/WQTeam/jquery-ajax-cache/releases) 最新 jquery-ajax-cache
bower
```javascript
bower install jquery-ajax-cache
```
npm
```javascript
npm install jquery-ajax-cache --save-dev
```
# 引入
```html
```
# 使用
因为在实际应用中，后台返回的结果可能是成功信息，也有可能是失败信息。所以只有业务上我们认为成功的请求我们才需要缓冲起来。jquery-ajax-cache插件预留了一个方法`cacheValidate`给使用者作为判断请求是否成功。
### 全局配置`cacheValidate`(该方法需要全局调用一次)
```javascript
$ajaxCache.config({
// 业务逻辑判断请求是否缓存， res为ajax返回结果, options 为 $.ajax 的参数
cacheValidate: function (res, options) { //选填，配置全局的验证是否需要进行缓存的方法,“全局配置” 和 ”自定义“，至少有一处实现cacheValidate方法
return true; // 所有情况都缓存
// return res.state === 'ok'; // 满足某个条件才缓存
// return false; // 不缓存
},
storageType: 'localStorage', //选填，‘localStorage’ or 'sessionStorage', 默认‘localStorage’
timeout: 60 * 60, //选填， 单位秒。默认1小时
});
$.ajax({
// 使用时 只要增加给ajax请求增加一行属性 ajaxCache: true
ajaxCache: true // “全局配置” 和 ”自定义“，至少有一处实现cacheValidate方法
/*
others...
*/
});
```
### 自定义单个请求的`cacheValidate`
```javascript
$.ajax(
// 此处的参数会覆盖‘全局配置’中的设置
ajaxCache: {
// 业务逻辑判断请求是否缓存， res为ajax返回结果, options 为 $.ajax 的参数
cacheValidate: function (res, options) { //选填，配置全局的验证是否需要进行缓存的方法, “全局配置” 和 ”自定义“，至少有一处实现cacheValidate方法
return true; // 所有情况都缓存
// return res.state === 'ok'; // 满足某个条件才缓存
// return false; // 不缓存
},
storageType: 'localStorage', //选填，‘localStorage’ or 'sessionStorage', 默认‘localStorage’
timeout: 60 * 60, //选填， 单位秒。默认1小时,
forceRefresh: false //选填，默认false 是否强制刷新请求。本次请求不读取缓存，同时如果请求成功会更新缓存。应用场景如：下拉刷新
}
});
```
### 清除过期数据
无特殊情况无需主动调用，插件会自动清除过期数据
```javascript
$ajaxCache.deleteAllExpires();
```