@sdkset

Appearance

Module: core/useStorage ​

Classes ​

Interfaces ​

Type Aliases ​

StorageProperty ​

Ƭ StorageProperty: keyof StorageFormat

存储数据属性。

StorageType ​

Ƭ StorageType: "localStorage" | "sessionStorage"

存储类型。

Functions ​

useStorage ​

▸ useStorage(storageType?, option?): WrapperStorage

返回一个Storage包装器对象。 包装器对Storage使用方式进行了简化并支持设置过期时间。

Example

ts
const storage = useStorage('localStorage', { expireTimeMs: 30 * 24 * 60 * 60 * 1000 })

storage.set('key', 'value')
storage.get('key')
=> 'value'

storage.get('unknown', 'defValue')
=> 'defValue'

storage.remove('key')
storage.get('key')
=> null

30 days later ...
storage.get('key')
=> null
const storage = useStorage('localStorage', { expireTimeMs: 30 * 24 * 60 * 60 * 1000 })

storage.set('key', 'value')
storage.get('key')
=> 'value'

storage.get('unknown', 'defValue')
=> 'defValue'

storage.remove('key')
storage.get('key')
=> null

30 days later ...
storage.get('key')
=> null

Default

ts
useStorage('localStorage', {
  expireTime: 30 * 24 * 60 * 60 * 1000 // 默认过期时间毫秒数
})
useStorage('localStorage', {
  expireTime: 30 * 24 * 60 * 60 * 1000 // 默认过期时间毫秒数
})

Parameters ​

NameTypeDescription
storageType?StorageType存储类型
option?CreateStorageOption包装器选项

Returns ​

WrapperStorage