# Xstore

**Repository Path**: jsqy/Xstore

## Basic Information

- **Project Name**: Xstore
- **Description**: the localStorage plus tool
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-01-11
- **Last Updated**: 2024-02-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Xstore

the localStorage plus tool

### 版本 

  - 1.0
###

### 说明 

  - 此工具是基于localStorage，如浏览器不支持，请勿使用！（呵呵哒，难道还有不支持的？）
  - 原生localStorage仅支持字符串，不支持多种JS类型存储，如对象、数组
  - 原生localStorage不支持过期时间，虽然很多人使用cookie来代替，显然也是一个好方法
  
###

## 使用

* 遵循：一看就懂、傻瓜操作

* 设置存储

```
setStore(key, value, time)
```

* 参数说明：

| 参数名 | 是否必填  | 说明 |
| :-- | :--: | :-- |
| key |   是 | 缓存的key |
|value|   否 | 缓存的内容，为空则值会设置为null，也就是删除  |
|time |   否 | 过期时间，单位：秒；若为null则表示永不过期，若为-1则表示将其缓存立刻设置为过期但保留缓存值的内容  |
	
* 亮点（坑）：

1. 缓存的key，支持'foo.bar.baz'的形式存储

2. 缓存值不支持函数类型，这里吹牛吹大了，以为什么类型都能支持，但是不支持函数类型，呵呵哒，这个也会在下一个版本（2.0）解决

3. 过期时间，这个的坑不大，很好，唯一一个设计还算合理的地方（其实不然，只是暂时没发现有更好的方法）

* 获取缓存

```
getStore(key)
```

同样支持'foo.bar.baz'形式，这个基本没坑还有亮点：会自动判断缓存是否过期，如果缓存已经过期则会返回null

* 设置缓存

```
setStore(key, value, time)
```

key：缓存key，支持'foo.bar.baz'形式

value：请使用对象存储，数组存储容易造成数据丢失，例如[b:'ddd']之类的数组存储会丢失数据

time: 单位秒，2.0会支持秒和时间戳两个方式

* 删除缓存

```
removeStore(key)
```