store.js 使用教程

store.js 使用教程

store.jsCross-browser storage for all use cases, used across the web.项目地址:https://gitcode.com/gh_mirrors/st/store.js

1. 项目的目录结构及介绍

store.js 是一个用于本地存储的 JavaScript 库，它提供了简洁的 API 来实现跨浏览器的本地存储功能。以下是 store.js 项目的目录结构及介绍：

store.js/
├── dist/
│   ├── store.min.js
│   ├── store.legacy.min.js
│   └── store.modern.min.js
├── src/
│   ├── store-engine.js
│   ├── storages/
│   │   ├── localStorage.js
│   │   ├── cookieStorage.js
│   │   └── sessionStorage.js
│   └── plugins/
│       ├── defaults.js
│       ├── expire.js
│       └── index.js
├── test/
│   ├── index.html
│   └── tests.js
├── .gitignore
├── .npmignore
├── LICENSE
├── Makefile
├── package.json
├── README.md
└── webpack.config.js

• dist/：包含编译后的文件，如 store.min.js、store.legacy.min.js 和 store.modern.min.js。
• src/：源代码目录，包含核心引擎 store-engine.js 和各种存储方式及插件。
• test/：测试文件目录，包含测试页面和测试脚本。
• .gitignore、.npmignore：Git 和 npm 忽略文件。
• LICENSE：项目许可证。
• Makefile：用于构建项目的 Makefile。
• package.json：npm 包配置文件。
• README.md：项目说明文档。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

store.js 的启动文件主要是 dist/ 目录下的编译后的文件，如 store.min.js。这些文件可以直接在 HTML 中引入使用。以下是一个简单的示例：

<script src="path/to/store.min.js"></script>
<script>
  store.set('username', 'marcus');
  console.log(store.get('username')); // 输出: marcus
</script>

3. 项目的配置文件介绍

store.js 的配置文件主要是 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的元数据和依赖信息，以下是部分关键内容：

{
  "name": "store",
  "version": "2.0.12",
  "description": "A localStorage wrapper for all browsers without using cookies or flash. Uses localStorage, globalStorage, and userData behavior under the hood",
  "main": "dist/store.legacy.min.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/marcuswestin/store.js.git"
  },
  "keywords": [
    "store",
    "localstorage",
    "localStorage",
    "globalstorage",
    "userdata"
  ],
  "author": "Marcus Westin <narcvs@gmail.com> (http://marcuswest.in)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/marcuswestin/store.js/issues"
  },
  "homepage": "https://github.com/marcuswestin/store.js#readme",
  "devDependencies": {
    "webpack": "^1.12.14"
  }
}

webpack.config.js

webpack.config.js 文件用于配置 Webpack 构建过程，以下是部分关键内容：

var webpack = require('webpack');
var path = require('path');

module.exports = {
  entry: {
    'store': './src/store-engine.js',
    'store.legacy': './src/store-engine.js',
    'store.modern': './src/store-engine.js'
  },
  output: {
    path: path.resolve(__dirname, '

store.jsCross-browser storage for all use cases, used across the web.项目地址:https://gitcode.com/gh_mirrors/st/store.js