ReAlign/LocalStorage

Encapsulate a simple LocalStorage Class

LocalStorage

Introduction

让使用 localStorage 变得更简单

1. 原生 localStorage 只能存储字符串
2. 对于复杂数据结构，在存储之前，必须先进行序列化
3. 对于复杂数据结构，在读取的时候，又需要反序列化
4. 直接操作数据，可能会对数据造成覆盖，中间最好有一层检测机制，保证数据的准确性
5. 对于 查询当前剩余容量 获取key列表 等一些快捷操作，也做了封装

针对上述，对 localStorage 进行一次封装，默认对数据进行序列化、反序列化、覆盖提醒、快捷处理等操作，用户只需关心自己要保存、获取的数据的一系列操作。

Usage

ES6

import LS from 'n-localstorage';

UMD

// download files
use n-localstorage/dist/localstorage.js

---

set(key, value, cover)

存储数据，返回 set 的对象
* set(key, value, cover = false)
* @params key
* @params value
* @params cover 是否覆盖
* return {
    key: key,
    val: value
}

Example:

LS.set('name', 'realign');
/**
return
{
    key: 'name',
    val: 'realign'
}
*/

get(key)

获取数据，返回 对应值（会保持原来的数据类型）
* get(key)
* return valye

Example:

LS.get('name'); // 'realign'

has(key)

判断是否存在此 key，返回 boolean
* has(key)
* return boolean

Example:

LS.has('name'); // true
LS.has('my'); // false

remove(key)

删除 key 对应的这条数据，
返回 boolean，该条数据是否仍存在
    已成功删除 true（传入不存在的key，仍会返回 true）
    未成功删除 false
* remove(key)
* return boolean

Example:

LS.remove('name'); // true

clear

清空当前域下 localstorage 数据
* clear()
* return boolean

Example:

LS.clear(); // true

getKeyList

获取 localstorage 所有 key
* getKeyList()
* return array 默认 []

Example:

LS.getKeyList(); // ['name', 'age']

getAll

获取 localstorage 所有 数据
* getAll()
* return object 默认 {}

Example:

LS.getAll(); // {'name': 'realign', 'age': 23}

getSurplusCapacityKb

保留，但会有误差，建议用下面的新 api { getSurplusCapacity }

获取 localstorage 剩余容量（kb）
* getSurplusCapacityKb()
* return number

Example:

LS.getSurplusCapacityKb(); // 5119.998046875

getSurplusCapacity

/** 获取 localstorage 剩余容量
 * getSurplusCapacity(unit)
 * @param   unit => b | kb | mb
 * @returns number
 */

// Example:

LS.getSurplusCapacity('kb'); // 4119.998046875