jStorage 技术文档

1. 安装指南

1.1 下载 jStorage

首先，您需要从GitHub项目中下载jStorage的源代码。您可以通过以下命令克隆项目：

git clone https://github.com/andris9/jStorage.git

1.2 引入 jStorage

将下载的jStorage文件引入到您的项目中。您可以选择使用未压缩的版本进行开发，或者使用压缩后的版本进行生产环境部署。

<script src="path/to/jstorage.min.js"></script>

1.3 依赖库

jStorage 是一个库无关的工具，但它需要依赖于某些JavaScript库来支持旧版IE浏览器。您可以选择引入Prototype、MooTools或JSON2来支持这些浏览器。

<script src="path/to/json2.js"></script>

2. 项目的使用说明

2.1 基本使用

jStorage 是一个跨浏览器的键值对存储数据库，可以在浏览器中本地存储数据。它支持存储字符串、数字、JavaScript对象、数组以及原生XML节点。

2.1.1 存储数据

使用 set 方法存储数据：

$.jStorage.set("myKey", "myValue");

2.1.2 获取数据

使用 get 方法获取数据：

var value = $.jStorage.get("myKey");

2.1.3 删除数据

使用 deleteKey 方法删除数据：

$.jStorage.deleteKey("myKey");

2.2 设置TTL（Time To Live）

您可以为存储的键设置TTL值，使其在指定时间后自动过期。

2.2.1 设置TTL

使用 setTTL 方法设置TTL：

$.jStorage.set("myKey", "myValue");
$.jStorage.setTTL("myKey", 3000); // 3秒后过期

2.2.2 获取TTL

使用 getTTL 方法获取剩余的TTL时间：

var ttl = $.jStorage.getTTL("myKey"); // 返回剩余的TTL时间（毫秒）

2.3 清空存储

使用 flush 方法清空所有存储的数据：

$.jStorage.flush();

2.4 获取所有键

使用 index 方法获取当前存储的所有键：

var keys = $.jStorage.index();
console.log(keys); // 输出所有键的数组

3. 项目API使用文档

3.1 设置数据

$.jStorage.set(key, value[, options])

• key：字符串类型的键名，否则会抛出异常。
• value：可以是任何JSON可序列化的值，包括对象、数组或XML节点。
• options：可选参数，当前仅支持 TTL 选项，用于设置键的过期时间。

3.2 获取数据

$.jStorage.get(key[, default])

• key：字符串类型的键名，否则会抛出异常。
• default：可选参数，如果键不存在，则返回该默认值。

3.3 删除键

$.jStorage.deleteKey(key)

• key：字符串类型的键名，否则会抛出异常。

3.4 设置TTL

$.jStorage.setTTL(key, ttl)

• key：字符串类型的键名，否则会抛出异常。
• ttl：TTL时间（毫秒），使用0或负值清除TTL。

3.5 获取TTL

$.jStorage.getTTL(key)

• key：字符串类型的键名，否则会抛出异常。
• 返回值：剩余的TTL时间（毫秒），如果未设置TTL则返回0。

3.6 清空存储

$.jStorage.flush()

3.7 获取所有键

$.jStorage.index()

• 返回值：当前存储的所有键的数组。

3.8 获取存储大小

$.jStorage.storageSize()

• 返回值：存储数据的大小（字节）。

3.9 获取当前存储引擎

$.jStorage.currentBackend()

• 返回值：当前使用的存储引擎，如果没有则返回 false。

3.10 重新初始化

$.jStorage.reInit()

• 重新加载浏览器存储中的数据。

3.11 检查存储是否可用

$.jStorage.storageAvailable()

• 返回值：如果存储可用则返回 true，否则返回 false。

3.12 订阅频道

$.jStorage.subscribe(channel, callback)

• channel：频道名称。
• callback：回调函数，接收频道名称和负载数据。

3.13 发布消息

$.jStorage.publish(channel, payload)

• channel：频道名称。
• payload：要发布的数据。

3.14 监听键变化

$.jStorage.listenKeyChange(key, callback)

• key：要监听的键名，使用 "*" 监听所有键的变化。
• callback：回调函数，接收键名和操作类型。

3.15 停止监听

$.jStorage.stopListening(key[, callback])

• key：要停止监听的键名。
• callback：可选参数，如果设置，则仅清除该回调函数，否则清除所有监听器。

4. 项目安装方式

4.1 通过 npm 安装

您可以通过npm安装jStorage：

npm install jstorage

4.2 通过 Bower 安装

您也可以通过Bower安装jStorage：

bower install jstorage

4.3 手动下载

您可以直接从GitHub项目页面下载jStorage的源代码，并将其引入到您的项目中。

<script src="path/to/jstorage.min.js"></script>

通过以上步骤，您可以成功安装并使用jStorage，享受其在浏览器中本地存储数据的便利功能。