Class StorageClient

StorageClient

Index

Constructors

Methods

clear getItem removeItem setItem

Constructors

constructor

new StorageClient(options?: StorageClientOptions): StorageClient
创建一个存储客户端实例
Parameters
- Optionaloptions: StorageClientOptions
  配置选项
Returns StorageClient
- Defined in cache/StorageClient.ts:31

Methods

clear

clear(): void
清除所有带有当前前缀的存储数据

Returns void
Example
```
client.clear() // 删除所有以'prefix-'开头的存储项
```
- Defined in cache/StorageClient.ts:106

getItem

getItem(key: string, defaultVal?: any): any
从指定键名获取存储的数据
Parameters
- key: string
  储键名（不需要包含前缀）
- OptionaldefaultVal: any
  当数据不存在/过期/解析失败时返回的默认值
Returns any
存储的值或默认值
Example
```
const user = client.getItem('user', { name: 'guest' })
```
- Defined in cache/StorageClient.ts:71

removeItem

removeItem(key: string): void
移除指定键名的存储数据
Parameters
- key: string
  储键名（不需要包含前缀）
Returns void
- Defined in cache/StorageClient.ts:96

setItem

setItem<T>(key: string, value: T, ttl?: number): void
存储数据到指定键名
Type Parameters
- T
  存储值的类型
Parameters
- key: string
  储键名（不需要包含前缀）
- value: T
  要存储的值（自动序列化）
- Optionalttl: number
  数据的存活时间（单位：毫秒），可选
Returns void
Example
```
client.setItem('user', { name: 'John' }, 60000) // 数据1分钟后过期
```
- Defined in cache/StorageClient.ts:56