Module vx-hooks/UseStorageStateAPI

useStorageState

• useStorageState<T>(storage: Storage, key: string, defaultValue?: T | (() => T)): { state: Ref<undefined | null | T>; update: (value?: T | null) => void }

• strong 本地缓存

  example

  
  sessionStorage.setItem('data', 10)
  const { state, update } = useStorageState(sessionStorage, 'data', 20)
  console.log(state.value) // 10
  update(40)
  console.log(state.value, sessionStorage) // undefined
  update()
  console.log(state.value, sessionStorage) // undefined
  
  

  Type parameters

  • T

  Parameters

  • storage: Storage

    缓存类型 sessionStorage | localStorage

  • key: string

    缓存字段

  • Optional defaultValue: T | (() => T)

    初始时，字段为空时的默认值

  Returns { state: Ref<undefined | null | T>; update: (value?: T | null) => void }

  • state: Ref<undefined | null | T>

  • update: (value?: T | null) => void

    • • (value?: T | null): void

      • Parameters

        • Optional value: T | null

        Returns void