localForage 是一个 JavaScript 库,经过简单相似 localStorage API 的异步存储来改进你的 Web 应用程序的离线体验。它能存储多种类型的数据,而不单单是字符串。es6
localForage 有一个优雅降级策略,若浏览器不支持 IndexedDB 或 WebSQL,则使用 localStorage。在全部主流浏览器中均可用:Chrome,Firefox,IE 和 Safari(包括 Safari Mobile)。数据库
使用 localForage,请 下载最新版本 或使用 npm(npm install localforage)或 bower(bower install localforage)进行安装。npm
而后,只需包含 JS 文件便可使用 localForage:。你不须要运行任何初始化方法或等待 onready 事件。后端
getItem(key, successCallback)api
从仓库中获取 key 对应的值并将结果提供给回调函数。若是 key 不存在,getItem() 将返回 null。promise
** 当存储 undefined 时, getItem() 也会返回 null。因为 localStorage 限制,同时出于兼容性的缘由 localForage 没法存储 undefined。浏览器
setItem(key, value, successCallback)异步
将数据保存到离线仓库。你能够存储以下类型的 JavaScript 对象:函数
. Array
. ArrayBuffer
. Blob
. Float32Array
. Float64Array
. Int8Array
. Int16Array
. Int32Array
. Number
. Object
. Uint8Array
. Uint8ClampedArray
. Uint16Array
. Uint32Array
. String对象
** 当使用 localStorage 和 WebSQL 做为后端时,二进制数据在保存(和检索)以前会被序列化。在保存二进制数据时,序列化会致使大小增大。
removeItem(key, successCallback)
从离线仓库中删除 key 对应的值。
clear(successCallback)
从数据库中删除全部的 key,重置数据库。
localforage.clear() 将会删除离线仓库中的全部值。谨慎使用此方法。
length(successCallback)
获取离线仓库中的 key 的数量(即数据仓库的“长度”)。
key(keyIndex, successCallback)
根据 key 的索引获取其名
** 虽然是从 localStorage API 延续而来的,但此方法被认为有点怪异。
keys(successCallback)
获取数据仓库中全部的 key。
iterate(iteratorCallback, successCallback)
迭代数据仓库中的全部 value/key 键值对。
iteratorCallback 在每个键值对上都会调用一次,其参数以下: 1. value 为值 2. key 为键名 3. iterationNumber 为迭代索引 - 数字
** 经过在 iteratorCallback 回调函数中返回一个非 undefined 的值,能提早退出 iterate。iteratorCallback 的返回值即做为整个迭代的结果,将被传入 successCallback。
这意味着若是你使用的是 CoffeeScript,那么你须要手动执行一个不带内容的 return 语句才能继续迭代全部的 key/value 键值对。