VueUseuseIDBKeyval
Wrapper for idb-keyval.
Demo
Available in the @vueuse/integrations add-on.Install idb-keyval as a peer dependency
bash
npm install idb-keyval
npm install idb-keyval
Usage
ts
import { useIDBKeyval } from '@vueuse/integrations/useIDBKeyval'
// bind object
const storedObject = 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>
// delete data from idb storage
storedObject.value = null
import { useIDBKeyval } from '@vueuse/integrations/useIDBKeyval'
// bind object
const storedObject = 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>
// delete data from idb storage
storedObject.value = null
Type Declarations
typescript
export interface UseIDBOptions extends ConfigurableFlush {
/**
* Watch for deep changes
*
* @default true
*/
deep?: boolean
/**
* On error callback
*
* Default log error to `console.error`
*/
onError?: (error: unknown) => void
/**
* Use shallow ref as reference
*
* @default false
*/
shallow?: boolean
}
/**
*
* @param key
* @param initialValue
* @param options
*/
export declare function useIDBKeyval<T>(
key: IDBValidKey,
initialValue: MaybeComputedRef<T>,
options?: UseIDBOptions
): RemovableRef<T>
export interface UseIDBOptions extends ConfigurableFlush {
/**
* Watch for deep changes
*
* @default true
*/
deep?: boolean
/**
* On error callback
*
* Default log error to `console.error`
*/
onError?: (error: unknown) => void
/**
* Use shallow ref as reference
*
* @default false
*/
shallow?: boolean
}
/**
*
* @param key
* @param initialValue
* @param options
*/
export declare function useIDBKeyval<T>(
key: IDBValidKey,
initialValue: MaybeComputedRef<T>,
options?: UseIDBOptions
): RemovableRef<T>
Source
Contributors
Anthony Fu
sun0day
Harmony Scarlet