Appearance
storage
storage 提供了一个统一的本地存储管理方案,采用单例模式封装了 localStorage、sessionStorage 和 cookie 的操作方法。
初始化
在使用存储功能之前,建议先初始化存储实例并设置统一的前缀:
typescript
import { initStorage } from '@qxs-bns/utils'
// 使用自定义前缀初始化
initStorage('myapp_')
// 不传参数则使用默认前缀 'qxs_'
initStorage()
基础用法
高级用法
API
获取存储实例
typescript
import { useStorage } from '@qxs-bns/utils'
const storage = useStorage()
local / session
方法 | 说明 | 参数 | 返回值 |
---|---|---|---|
has(key: string) | 检查是否存在指定键 | key: 存储键名 | boolean |
get(key: string) | 获取存储值 | key: 存储键名 | string | null |
set(key: string, value: string) | 设置存储值 | key: 存储键名, value: 存储值 | void |
remove(key: string) | 删除指定键值对 | key: 存储键名 | void |
clear() | 清空所有存储 | - | void |
cookie
方法 | 说明 | 参数 | 返回值 |
---|---|---|---|
has(key: string) | 检查是否存在指定 cookie | key: cookie 名 | boolean |
get(key: string) | 获取 cookie 值 | key: cookie 名 | string | null |
set(key: string, value: string, expires?: number, path?: string, domain?: string) | 设置 cookie | key: cookie 名 value: cookie 值 expires: 过期天数(默认1天) path: 路径(默认'/') domain: 域名(默认当前顶级域名) | void |
remove(key: string, path?: string, domain?: string) | 删除指定 cookie | key: cookie 名 path: 路径(默认'/') domain: 域名(默认当前顶级域名) | void |
clear() | 清空所有 cookie | - | void |
注意事项
- 建议在应用初始化时调用
initStorage
设置统一的前缀 - 所有存储的键名都会自动添加配置的前缀
- Cookie 操作会自动处理域名、编码解码等细节
- 使用单例模式确保全局使用相同的存储实例
- 如果未调用
initStorage
,将使用默认前缀 'qxs_'