@sdksetClass: WrapperStorage
core/useStorage.WrapperStorage
包装器类。
Constructors
constructor
• new WrapperStorage(storage, option)
Parameters
| Name | Type |
|---|---|
storage | Storage |
option | Required<CreateStorageOption> |
Properties
#expireTimeMs
• Private Readonly #expireTimeMs: number
#storage
• Private Readonly #storage: Storage
Accessors
self
• get self(): Storage
storage对象。
Returns
Storage
Methods
clear
▸ clear(): void
清空storage中的所有键名。
Example
ts
useStorage().clear()useStorage().clear()Returns
void
get
▸ get(key, def?, property?): any
返回storage给定键的值，支持默认值和萃取属性，如有设置过期时间且数据已过期返回null。
Example
ts
useStorage().get('unknown', 'defValue')
=> 'defValue'
useStorage().set('key', 'value', 'expireTimeMs')
useStorage().get('key')
=> { data }
...After time...
useStorage().get('key')
=> null
useStorage().get('key', 'def', 'fieldName')
=> data[fieldName]useStorage().get('unknown', 'defValue')
=> 'defValue'
useStorage().set('key', 'value', 'expireTimeMs')
useStorage().get('key')
=> { data }
...After time...
useStorage().get('key')
=> null
useStorage().get('key', 'def', 'fieldName')
=> data[fieldName]Parameters
| Name | Type | Description |
|---|---|---|
key | string | 给定键 |
def? | unknown | 默认值 |
property? | keyof StorageFormat | 萃取属性 |
Returns
any
remove
▸ remove(key): void
删除storage中的给定键名。
Example
ts
useStorage().remove('key')useStorage().remove('key')Parameters
| Name | Type | Description |
|---|---|---|
key | string | 给定键 |
Returns
void
set
▸ set(key, value, customExpireMs?): void
将键值对添加到storage中，如果键名存在，则更新其对应的值。
Example
ts
useStorage().set('key', 'value')
useStorage().set('key', 'value', new Date().getTime() + oneDay)useStorage().set('key', 'value')
useStorage().set('key', 'value', new Date().getTime() + oneDay)Parameters
| Name | Type | Description |
|---|---|---|
key | string | 给定键 |
value | unknown | 给定值 |
customExpireMs? | number | true | 给定过期时间（毫秒），传递 true 则使用默认选项的过期时间 |
Returns
void