# simple-easy-local-storage

> A lightweight localstorage npm package

Latest version **2.0.1** (published 2022-08-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install simple-easy-local-storage
pnpm add simple-easy-local-storage
yarn add simple-easy-local-storage
bun add simple-easy-local-storage
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-08-22 |
| First published | 2022-05-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | baiyunsong |
| Maintainers | baiyunsong |
| Keywords | localStorage, sessionStorage, cache, local, storage |

## Links

- npm: https://www.npmjs.com/package/simple-easy-local-storage
- Repository: https://github.com/15826954460/tiny-storage
- Homepage: https://github.com/15826954460/tiny-storage#readme
- Issues: https://github.com/15826954460/tiny-storage/issues
- npm.io page: https://npm.io/package/simple-easy-local-storage

## Dependencies (4)

- [express](https://npm.io/package/express.md) ^4.18.1
- [rollup-plugin-serve](https://npm.io/package/rollup-plugin-serve.md) ^1.1.0
- [rollup-plugin-terser](https://npm.io/package/rollup-plugin-terser.md) ^7.0.2
- [@rollup/plugin-node-resolve](https://npm.io/package/@rollup/plugin-node-resolve.md) ^13.1.1

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-08-22
- 2.0.0 — 2022-08-22
- 1.0.6 — 2022-05-22
- 1.0.5 — 2022-05-05
- 1.0.4 — 2022-05-05
- 1.0.3 — 2022-05-05
- 1.0.2 — 2022-05-05
- 1.0.1 — 2022-05-05
- 1.0.0 — 2022-05-05

## README

#### wps-storage-sdk

simple-easy-local-storage

#### 项目使用

##### 引用

```js
import { TinyStorage } from "simple-easy-local-storage";
const storage = new TinyStorage({
  // ...options
});
```

##### 方法

```js
// 获取所有本地储存的key
storage.getKeys();

/**
 * @description 添加修改数据
 * @param {
 *  key: '键', type string 必传
 *  val: '值', type ["string", "array", "object", "Symbol", "map"] 必传
 *  time: '过期时间(以秒为单位)', type number 默认：0
 * }
 */
storage.setItem(key, val, time);
/**
 * @description 获取数据
 * @param {
 *  key: '键', type string 必传
 * }
 */
storage.getItem(key);

/**
 * @description 删除数据
 * @param {
 *  key: '键', type string 必传
 * }
 */
storage.removeItem(key);

// 删除所有数据
storage.clearAll();
```

#### 选项 options

|       参数       |  类型   |                         默认                          | 说明             |
| :--------------: | :-----: | :---------------------------------------------------: | ---------------- |
| **storageType**  | String  |                     localStorage                      | 项目名称         |
|   **pordName**   | String  |                          ''                           | 项目名称         |
|     **env**      | String  |                      production                       | 当前环境         |
|   **version**    | String  |                          ''                           | 当前版本         |
|  **allowConso**  | Boolean |                         false                         | 是否允许日志打印 |
|  **catchTime**   | number  |                        3600000                        | 缓存时长         |
| **dataTypeList** |  Array  | ["String","Number","Array","Object","Symbol", "Map",] | 默认数据类型检测 |

#### 版本功能介绍

version 0.0.6

- [x] 支持默认缓存 1h
- [x] 支持 sessionStorage & localStorage
- [x] 支持日志打印
- [x] 支持全局缓存以及局部缓存
- [x] 支持自定义数据类型

---
_Source: https://npm.io/package/simple-easy-local-storage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._