0.2.0 • Published 2 years ago

storage-pocket v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

pocketjs

npm.io license Build Status Coveralls npm NPM downloads Percentage of issues still open

简单的 LocalStorage 数据管理工具

:star: 特性

  • 可以对 LocalStorage 内储存的数据很方便的管理,不用反复输入localstorage了
  • 可以对数据设置过期时间,已经过期的数据将会打上标记,方便对有时效性的数据进行操作
  • 对localstorage中的数据进行加密,别人获取到了也没法干什么事,更加安全了

:pill: 兼容性

单元测试保证支持如下环境:

IECHFFSFOPIOSAndroidNode
6+29+55+9+50+9+4+4+

注意:编译代码依赖ES5环境,对于ie6-8需要引入es5-shim才可以兼容,可以查看demo/demo-global.html中的例子

:open_file_folder: 目录介绍

.
├── demo 使用demo
├── dist 编译产出代码
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能

:rocket: 使用者指南

通过npm下载安装代码

$ npm install --save storage-pocket

如果你是node环境

var base = require('storage-pocket');

如果你是webpack等环境

import index from 'storage-pocket';

如果你是requirejs环境

requirejs(['node_modules/storage-pocket/dist/index.aio.js'], function (base) {
    // xxx
})

如果你是浏览器环境

<script src="node_modules/storage-pocket/dist/index.aio.js"></script>

:bookmark_tabs: 文档

API

:kissing_heart: 贡献者指南

首次运行需要先安装依赖

$ npm install

一键打包生成生产代码

$ npm run build

运行单元测试:

$ npm test

注意:浏览器环境需要手动测试,位于test/browser

修改 package.json 中的版本号,修改 README.md 中的版本号,修改 CHANGELOG.md,然后发布新版

$ npm run release

将新版本发布到npm

$ npm publish

贡献者列表

contributors

:gear: 更新日志

CHANGELOG.md

:airplane: 计划列表

TODO.md