autojs-storages

目前Autojs Pro V9的nodejs模式还没有rhino模式的storages本地存储模块，于是我自己写了一个。

数据会以文件的形式存储在app的内部files目录内，当然前提是aj的nodejs脚本，非aj环境会存储在项目根目录内。

快速开始

保存整数等简单数据。

1. 安装

npm install autojs-storages

2. 使用

CJS:

const storages = require('autojs-storages');
var storage = storages.create("Auto.js例子:简单数据");
var a = 1234;
var b = true;
var str = "hello";
//保存
storage.put("a", a);
storage.put("b", b);
storage.put("str", str);

//取出
console.log("a = " + storage.get("a"));
console.log("b = " + storage.get("b"));
console.log("str = " + storage.get("str"));

ESM:

import storages from 'autojs-storages';
var storage = storages.create("Auto.js例子:简单数据");
var a = 1234;
var b = true;
var str = "hello";
//保存
storage.put("a", a);
storage.put("b", b);
storage.put("str", str);

//取出
console.log("a = " + storage.get("a"));
console.log("b = " + storage.get("b"));
console.log("str = " + storage.get("str"));

API

storages

new storages(name[, maxSize = 5 * 1024])

storages.create(name[, maxSize = 5 * 1024])

创建一个本地存储并返回一个Storage对象。

| | | | --------- | ---------------------------------------- | | name | 本地存储名称 String | | maxSize | 可选，本地存储大小上限，默认5kb Number |

不同名称的本地存储的数据是隔开的，而相同名称的本地存储的数据是共享的。

实际上本模块会根据名称创建文件夹，用以存储数据文件。

例如在一个脚本中，创建名称为ABC的存储并存入a=123:

import storages from 'autojs-storages';
var storage = storages.create("ABC");
storage.put("a", 123);

而在另一个脚本中是可以获取到ABC以及a的值的：

import storages from 'autojs-storages';
var storage = storages.create("ABC");
console.log("a = " + storage.get("a"));

因此，本地存储的名称比较重要，尽量使用含有域名、作者邮箱等唯一信息的名称来避免冲突，例如：

import storages from 'autojs-storages';
var storage = storages.create("[email protected]:ABC");

storages.remove(name)

| | | | --------- | ---------------------------------------- | | name | 本地存储名称 String |

删除一个本地存储以及他的全部数据。如果该存储不存在，返回false；否则返回true。

Storages

Storage.set(key[, defaultValue])

Storage.setItem(key[, defaultValue])

Storage.put(key[, defaultValue])

| | | | --------- | ---------------------------------------- | | key | 键值 String | | defaultValue | 可选，默认值 Any |

从本地存储中取出键值为key的数据并返回。

如果该存储中不包含该数据，这时若指定了默认值参数则返回默认值，否则返回undefined。

返回的数据可能是任意数据类型，这取决于保存该键值的数据时的数据类型。

Storage.set(key, value)

Storage.setItem(key, value)

Storage.put(key, value)

| | | | --------- | ---------------------------------------- | | key | 键值 String | | value | 值 Any |

把值value保存到本地存储中。value可以是undefined以外的任意数据类型。如果value为undefined则抛出TypeError。

存储的过程实际上是使用JSON.stringify把value转换为字符串再保存，因此value必须是可序列化的才能被接受。

Storage.remove(key)

Storage.removeItem(key)

| | | | --------- | ---------------------------------------- | | key | 键值 String |

移除键值为key的数据。不返回任何值。

Storage.contains(key)

Storage.containsItem(key)

Storage.has(key)

| | | | --------- | ---------------------------------------- | | key | 键值 String |

返回该本地存储是否包含键值为key的数据。是则返回true，否则返回false。

Storage.clear()

移除该本地存储的所有数据。不返回任何值。