Back to Vueuse

useIDBKeyval

packages/integrations/useIDBKeyval/index.md

14.3.0751 B
Original Source

useIDBKeyval

Wrapper for idb-keyval.

Install idb-keyval as a peer dependency

bash
npm install idb-keyval@^6

Usage

ts
import { useIDBKeyval } from '@vueuse/integrations/useIDBKeyval'

// bind object
const { data: storedObject, isFinished } = useIDBKeyval('my-idb-keyval-store', { hello: 'hi', greeting: 'Hello' })

// update object
storedObject.value.hello = 'hola'

// bind boolean
const flag = useIDBKeyval('my-flag', true) // returns Ref<boolean>

// bind number
const count = useIDBKeyval('my-count', 0) // returns Ref<number>

// awaiting IDB transaction
await count.set(10)
console.log('IDB transaction finished!')

// delete data from idb storage
storedObject.value = null