Skip to content

useStorage

useStorage(key, defaultValue): Object

storage hooks

参数

NameTypeDescription
keystring | string[]要操作的缓存键
defaultValueany

返回值

Object

NameType
remove() => void
set(value: any, options?: { expiredAt: undefined | number ; expiresIn: undefined | number }) => void
valueany

remove: () => void

删除缓存值


set: (value: any, options?: { expiredAt: undefined | number ; expiresIn: undefined | number }) => void

设置缓存的值


value: any

该 value 为当前存储的值,只读,但响应式可被监听


示例

ts
const STORAGE_KET = {
  ENABLE: 'enable',
}
const enableStorage = useStorage(STORAGE_KET.ENABLE, false)

console.log(enableStorage.value) // false

enableStorage.set(true, {
  // 需要注意,当数据过期后,仅会在下次进入页面时将数据恢复默认值
  // 如果一直停留在当前页面,则数据不会恢复默认值
  expiredAt: dayjs().add(1, 'day').unix(),
})

console.log(enableStorage.value) // true

源码

use-storage.js