matias-storage v0.2.0

mt-storage

web storage的简单二次封装。

说明

• 存储值支持对象类型object、string、 boolean、 number、 null、 undefined，number时值不能为NaN，undefined等同删除。
• 读取时支持传递类型，但只是为了方便在TS中使用。不会做任何类型转换，使用则需要自己保证存取类型的一致性。

目前支持localStorage和sessionStorage两种存储。

注意如果数据量比较大，可能有性能问题，可以考虑DB存储。

使用

安装

• pnpm

$ pnpm add -D matias-storage

• yarn

$ yarn add -D matias-storage

• npm

$ npm install -D matias-storage

使用

import { WebStorageType, storageWrite, storageRead, storageRemove, storageRemoveAll } from 'matias-storage'

interface TestType {
    value: number
}

const obj: TestType = {
    value: 100
}

const LOCL_OBJECT_KEY = 'LOCL_OBJECT'
const SESSION_OBJECT_KEY = 'SESSION_OBJECT'
// 存储

// 默认使用localStorage
storageWrite(LOCL_OBJECT_KEY, obj)
// 使用sessionStorage
storageWrite(SESSION_OBJECT_KEY, obj, WebStorageType.SESSION)

// 读取

const localObjectValue = storageRead<TestType>(LOCL_OBJECT_KEY)
// **注意**使用者需自己保证存储的类型和读取类型的一致性
console.log(typeof localObjectValue?.value) // number

// 删除

storageRemove(LOCL_OBJECT_KEY)
storageWrite(LOCL_OBJECT_KEY, undefined)// 保存undefined，等同删除

// 清除localStorage
storageRemoveAll()
// 清除sessionStorage
storageRemoveAll(WebStorageType.SESSION)

版本

0.2.0

• 添加存储值类型为null、 undefined的支持。
• 调整逻辑number时值不能为NaN，undefined等同删除。

0.1.0

• 支持object、string、boolean、number类型存储。
• 支持localStorage和sessionStorage存储。
• 读取支持指定类型。