# mystores

**Repository Path**: lineCodeJm/mystores

## Basic Information

- **Project Name**: mystores
- **Description**: 同步仓库
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/holyhigh2/mystores
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-05-22
- **Last Updated**: 2023-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# MyStores
![npm](https://img.shields.io/npm/v/mystores)
![NPM](https://img.shields.io/npm/l/mystores)

一个基于localStorage/sessionStorage/cookie/indexedDB的webstore统一键值操作API

## 特性
- 统一存储API
- 多类型store支持
- 支持任意数据序列化/反序列化
- 支持过期时间设置

## 安装

```
npm i mystores
```

## 用法
```js
//1. 写入缓存
MyStore.set('a',{a:1})
MyStore.set('b',/123/)
MyStore.set('c',new Date())
MyStore.set('d',-123)
MyStore.set('e',null)
MyStore.set('f',Infinity)

//2. 读取缓存
MyStore.get('a')//获取到对象
MyStore.set('b',/123/)//获取到正则
MyStore.set('c',new Date())//获取到date对象

//3. 获取所有key
MyStore.keys()
```

## API
```ts
import Stores from 'mystores'

//支持的store类型
Store.type = 'store'|'cookie'|'indexed';

//设置缓存。options参数仅在type为cookie时支持
Store.set(key:string,value:any,expires?:number,options?:{path:string,domain?:string,secure:boolean}):boolean|Promise<boolean>

//获取缓存值
Store.get(key: string):any|Promise<any>

//获取缓存值的字符串，当type为indexed时，永远返回null
Store.getString(key: string):string|null

//删除指定key缓存数据
Store.remove(key:string):boolean|Promise<boolean>

//检测指定key缓存是否存在
Store.has(key:string):boolean|Promise<boolean>

//获取所有缓存key
Store.keys():string[] | Promise<string[]>

//清除所有缓存
Store.clear()
```
***当type为indexed时，所有返回值非空API都变为Promise对象***

## demo
见test/index.spec.ts