@guohanmin/storage
v1.0.0跨存储介质工具库:封装 localStorage、sessionStorage 与 Cookie,支持可选加密、智能序列化与向后兼容数据迁移
pnpm add @guohanmin/storage共 16 个公开导出,按类型分组。
函数
- clearSession函数
清空 sessionStorage 的全部数据
查看详情 - clearStorage函数
清空 localStorage 的全部数据
查看详情 - configure函数
注入加密/日志适配器,只覆盖显式提供的字段,未提供的字段维持之前的配置 logger 默认使用 console,保证零配置可用;encrypt 默认不提供,读写均为明文
查看详情 - getCookie函数
从 Cookie 读取值 对象通过 JSON 反序列化返回,基础类型以字符串返回(与 getStorage 一致,不做数字/布尔还原); SSR/非浏览器环境下静默返回 def
查看详情 - getSession函数
从 sessionStorage 读取值 对象通过 JSON 反序列化返回;基础类型额外做一步还原——数字字符串还原为 number, `'true'`/`'false'` 还原为 boolean,其余原样返回字符串;SSR/非浏览器环境下静默返回 def
查看详情 - getStorage函数
从 localStorage 读取值 对象通过 JSON 反序列化返回,基础类型以字符串返回;SSR/非浏览器环境下静默返回 def
查看详情 - removeCookie函数
删除指定 Cookie(写入一个已过期的同名 Cookie 使浏览器立即失效)
查看详情 - removeSession函数
删除 sessionStorage 中的指定 key
查看详情 - removeStorage函数
删除 localStorage 中的指定 key
查看详情 - setCookie函数
写入 Cookie;对象自动 JSON 序列化;若已通过 configure() 注入加密适配器且启用,会先加密再写入
查看详情 - setSession函数
写入 sessionStorage;对象自动 JSON 序列化;若已通过 configure() 注入加密适配器且启用,会先加密再写入
查看详情 - setStorage函数
写入 localStorage;对象自动 JSON 序列化;若已通过 configure() 注入加密适配器且启用,会先加密再写入
查看详情
接口
- CookieOptions接口
{@link setCookie}/{@link removeCookie} 支持的 Cookie 属性
查看详情 - EncryptAdapter接口
加密适配器接口,由业务层实现并通过 {@link configure} 注入 `isEncrypted` 是运行时可读写的开关:业务层可以直接修改自己持有的适配器实例的 该字段来动态启停加密,而不必重新调用 configure()
查看详情 - LoggerAdapter接口
日志适配器接口,默认使用全局 console,业务层可替换为自己的日志库
查看详情 - StorageConfig接口
{@link configure} 的配置项,两个字段均可选,未提供的字段维持上一次的配置
查看详情