@redchili/storage-util
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

storage-util

localStorage 和 sessionStorage 的工具库,增加 typescript的类型定义,可以在业务中限制 key-value 的类型,防止代码里无序的使用 storage。

使用方式

  1. 初始化并导出 storage 实例
// session-util.ts
import StorageBase from "@redchili/storage-util";

export interface SessionProps { // 定义好业务中用到的所有 session key-value 类型
  token: string;
  money: money;
  thing: any;
}

export type SessionKey = keyof SessionProps;

const sessionUtil = new StorageBase<SessionProps>("sessionStorage"); // localStorage

export default sessionUtil;
  1. 在代码中使用 sessionUtil
import sessionUtil from 'session-util'

sessionUtil.getItem('token');// great
sessionUtil.getItem('authToken'); // invalid, ts error

sessionUtil.setItem('token', '123123'); // great
sessionUtil.setItem('token', 123123); // invalid, ts error

Readme

Keywords

none

Package Sidebar

Install

npm i @redchili/storage-util

Weekly Downloads

5

Version

0.1.0

License

MIT

Unpacked Size

4.76 kB

Total Files

8

Last publish

Collaborators

  • redchili