Skip to content

⬅️ Back to Table of Contents

📄 useLocalStorage

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 5

📚 Table of Contents

🛠️ File Location:

📂 packages/core/useLocalStorage/index.ts

📦 Imports

Name Source
RemovableRef @vueuse/shared
MaybeRefOrGetter vue
UseStorageOptions ../useStorage
defaultWindow ../_configurable
useStorage ../useStorage

Functions

useLocalStorage(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<string>, options: UseStorageOptions<string>): RemovableRef<string>

Parameters:

  • key MaybeRefOrGetter<string>
  • initialValue MaybeRefOrGetter<string>
  • options UseStorageOptions<string>

Returns: RemovableRef<string>

Code
export function useLocalStorage(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<string>, options?: UseStorageOptions<string>): RemovableRef<string>

Generated by Syntax Scribe