etdsolutions/jquery-ajax-localstorage-cache

此包的最新版本(dev-master)没有可用的许可信息。

使用浏览器的本地存储缓存存储ajax响应

dev-master 2015-11-26 08:18 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:09:30 UTC


README

jquery-ajax-localstorage-cache - 简称Jalc,因为全名太长了。

Jalc是一个为jQuery(>1.5.1)和实现存储接口的任何对象(例如localStorage)构建的插件。

它基于从jStorage依赖的原始版本的分支构建。它提供客户端缓存,旨在节省带宽和时间。

使用方法

参数

	$.ajax({
		url          : '/post',
		localCache   : true,        // Required. Either a boolean, in which case localStorage will be used, or
		an object that implements the Storage interface.

		cacheTTL     : 1,           // Optional. In hours.
		cacheKey     : 'post',      // optional.
		isCacheValid : function(){  // optional.
			return true;
		}
	}).done(function(response){
	    // The response is available here.
	});

在您的AJAX请求中,您将获得4个新参数

  • localCache
    • 开启/关闭localCache,或指定实现Storage接口的对象来使用。
    • 默认:false
  • cacheTTL
    • 条目应有效的时长(小时)。
    • 仅针对此特定的AJAX请求
    • 默认:5小时
  • cacheKey
    • CacheKey是用于在localStorage中存储响应的键。它允许您使用localStorage.removeItem()函数轻松删除缓存。
    • 默认:URL + TYPE(GET/POST) + DATA
  • isCacheValid
    • 此函数必须返回true或false。当为false时,缓存的响应将被删除。
    • 默认:null

备注

  • 您可以使用localStorage.clear()或使用localStorage.removeItem('cacheKey')(如果您指定了cacheKey)来删除缓存。注意上述假设您正在使用localStorage - 根据需要替换为您实现的Storage接口对象。
  • 请注意,您可以使用此插件预先加载内容。您只需使用相同的cacheKey执行一个初始的AJAX请求。

许可

此项目根据Apache 2许可证分发。有关更多信息,请参阅LICENSE.txt。