node-localstorage 技术文档

node-localstorage 技术文档

node-localstorage A drop-in substitute for the browser native localStorage API that runs on node.js. 项目地址: https://gitcode.com/gh_mirrors/no/node-localstorage

项目简介

node-localstorage 是一个在 Node.js 环境中运行的库，它提供了与浏览器原生 localStorage API 完全兼容的接口。通过这个库，开发者可以在服务器端使用类似于浏览器中的 localStorage 来进行数据持久化存储。

安装指南

安装方式

使用 npm 进行安装：

npm install node-localstorage

环境要求

• Node.js 版本 >= 14.x

项目使用说明

基本使用

以下是 node-localstorage 的基本使用示例：

JavaScript 示例

if (typeof localStorage === "undefined" || localStorage === null) {
  var LocalStorage = require('node-localstorage').LocalStorage;
  localStorage = new LocalStorage('./scratch');
}

localStorage.setItem('myFirstKey', 'myFirstValue');
console.log(localStorage.getItem('myFirstKey'));  // 输出: myFirstValue

CoffeeScript 示例

unless localStorage?
  {LocalStorage} = require('../')  # require('node-localstorage') for you
  localStorage = new LocalStorage('./scratch')

localStorage.setItem('myFirstKey', 'myFirstValue')
console.log(localStorage.getItem('myFirstKey'))  # 输出: myFirstValue

localStorage._deleteLocation()  # 清理 ./scratch 目录

ReactJs 示例

在 React 项目中，可以在 src/setupTests.js 文件中添加以下代码：

// /src/setupTests.js
import { LocalStorage } from "node-localstorage";

global.localStorage = new LocalStorage('./scratch');

作为 Polyfill 使用

可以通过以下方式将 node-localstorage 作为全局 localStorage 使用：

node -r node-localstorage/register my-code.js

项目 API 使用文档

主要方法

• setItem(key, value): 设置键值对。
• getItem(key): 获取指定键的值。
• removeItem(key): 移除指定键的值。
• key(n): 获取第 n 个键的名称。
• clear(): 清空所有存储的数据。
• length: 获取存储的键值对数量。

高级功能

• _sync(): 从磁盘重新读取文件。适用于多个进程访问同一存储位置的场景。
• _deleteLocation(): 清理存储目录。

事件支持

node-localstorage 支持事件，遵循 localStorage 规范。事件会在当前进程中触发。

限制

• 使用关联数组或点属性语法时，键名不能与库的私有属性和方法冲突，例如不能以 _ 开头。
• 如果指定的存储位置已有文件，可能会超出配额或比预期更快超出配额。

项目安装方式

通过 npm 安装：

npm install node-localstorage

结语

node-localstorage 提供了一个简单易用的数据持久化解决方案，适用于多种应用场景。我们鼓励您尝试使用这个库，并根据您的实际需求对其进行定制。如果您有任何问题或建议，请访问项目的 GitHub 页面 了解更多信息，参与讨论或者提交问题报告。

希望您喜欢这个项目！

node-localstorage A drop-in substitute for the browser native localStorage API that runs on node.js. 项目地址: https://gitcode.com/gh_mirrors/no/node-localstorage