npm 包 simpan.js 使用教程

简介

simpan.js 是一个用于简化数据持久化和本地存储的 npm 包，它支持将 JSON 数据以文件的形式存储在本地。simpan.js 还支持以加密的方式存储数据，以保障数据的安全。

安装

安装 simpan.js 非常容易，使用 npm 命令即可：

npm install simpan --save

使用

初始化

在使用 simpan.js 之前，需要先初始化它，这可以通过传入一个对象来实现，例如：

const simpan = require('simpan');

simpan.init({
    dir: './data',
    cryptkey: 'your-secret-key',
    cryptmethod: 'aes-256-cbc'
});

• dir: 指定数据文件存储的目录，默认为当前工作目录中的 data 目录。
• cryptkey: 指定加密密钥，如果不指定，simpan.js 将不会加密数据。
• cryptmethod: 指定加密算法名称，如果不指定，simpan.js 将默认使用 aes-256-cbc 算法。

保存数据

保存数据非常简单，只需调用 save 方法，并将数据放入其中即可：

simpan.save('person', {
    name: 'John',
    age: 22
});

在默认情况下，数据将以 JSON 格式保存在 ./data/person.json 文件中，如果启用加密功能，将以 ./data/person.json.enc 文件名保存。

读取数据

读取数据同样非常简单，只需调用 load 方法：

let person = simpan.load('person');
console.log(person);

在默认情况下，simpan.js 将自动寻找 ./data/person.json 文件，并将其转换为 JSON 对象。如果启用加密功能，则自动加载 ./data/person.json.enc 文件并将其解密后返回为 JSON 对象。

删除数据

删除数据可以使用 remove 方法：

simpan.remove('person');

simpan.js 将删除 ./data/person.json 或 ./data/person.json.enc 文件。

清空所有数据

清空所有数据可以使用 clear 方法：

simpan.clear();

simpan.js 将删除 ./data 目录下的所有文件。

指导意义

simpan.js 是一款非常方便的数据持久化工具，它可以轻松帮助我们存储和访问 JSON 数据。此外，它还支持加密功能，以保障数据安全。simpan.js 在前端开发中非常实用，如用于保存用户的个性化设置等场景。因此，学习和掌握 simpan.js 的使用方法对于前端工程师来说非常重要。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055a2981e8991b448d7caa