Store.js 技术文档

本文档旨在帮助用户详细理解并使用 Store.js 项目。以下是关于安装、使用、API 和安装方式的详细介绍。

1. 安装指南

Store.js 提供了多种安装方式，以满足不同用户的需求。

使用 npm 安装

npm i store

使用 npm 安装后，可以在 JavaScript 文件中通过以下方式引用 Store.js：

var store = require('store')

使用 script 标签

首先，从 项目发行版页面 下载相应的构建文件，然后通过 script 标签引入：

<script src="path/to/my/store.legacy.min.js"></script>

在 HTML 文件中，可以直接使用全局变量 store：

<script>
store.set('user', { name:'Marcus' })
store.get('user').name == 'Marcus'
</script>

2. 项目的使用说明

Store.js 提供了一个简单的 API 用于跨浏览器本地存储。以下是一些基本用法：

设置和获取值

// 设置当前用户
store.set('user', { name:'Marcus' })

// 获取当前用户
store.get('user')

// 移除当前用户
store.remove('user')

// 清除所有键
store.clearAll()

// 遍历所有存储的值
store.each(function(value, key) {
    console.log(key, '==', value)
})

3. 项目 API 使用文档

以下是 Store.js 暴露的 API：

• store.set(key, value): 设置一个键值对。
• store.get(key): 获取一个键的值。
• store.remove(key): 移除一个键。
• store.clearAll(): 清除所有键。
• store.each(callback): 遍历所有键值对。

4. 项目安装方式

Store.js 的安装方式已在“安装指南”中详细介绍。以下是总结：

• 使用 npm 安装：npm i store
• 使用 script 标签引入构建文件

不同构建文件适用于不同的浏览器和环境。具体构建文件如下：

• store.everything.min.js: 包含所有插件和存储。
• store.legacy.min.js: 支持所有测试过的浏览器。
• store.modern.min.js: 支持所有现代浏览器。
• store.v1-backcompat.min.js: 与 Store.js v1 完全兼容。

以上就是 Store.js 的技术文档，希望对用户有所帮助。