# js-local-zye

> localStorage API 的封装及功能升级

Latest version **1.0.0** (published 2023-05-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-local-zye
pnpm add js-local-zye
yarn add js-local-zye
bun add js-local-zye
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-05-11 |
| First published | 2023-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zengyuee |
| Maintainers | zengyuee |

## Links

- npm: https://www.npmjs.com/package/js-local-zye
- npm.io page: https://npm.io/package/js-local-zye

## Recent versions

- 1.0.0 (latest) — 2023-05-11

## README

js-local-zye 是 localStorage API 的封装及功能升级，可设置缓存有效期
# 安装
```javascript
npm i js-local-zye
```
# 引入js-local-zye
```javascript
import Local from 'js-local-zye'
```
# 使用
## 设置缓存
参数
name：缓存的 key
value: 缓存的 key 对应的 value 值
expires: 有效期，单位毫秒（ms）

```javascript
Local.set(name, value, [expires]) // expires 可选参数，有效期
```
## 获取缓存
如果设置了有效期，有效期内返回value值，过了有效期 remove 缓存，返回false
```javascript
Local.get(name)
```
## 移除缓存
```javascript
Local.remove(name)
```

## 清空缓存
```javascript
Local.clear()
```

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