41 lines
924 B
TypeScript
41 lines
924 B
TypeScript
import { ConfigurableFlush, MaybeRefOrGetter, RemovableRef } from '@vueuse/shared';
|
|
import { Ref } from 'vue-demi';
|
|
|
|
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;
|
|
/**
|
|
* Write the default value to the storage when it does not exist
|
|
*
|
|
* @default true
|
|
*/
|
|
writeDefaults?: boolean;
|
|
}
|
|
/**
|
|
*
|
|
* @param key
|
|
* @param initialValue
|
|
* @param options
|
|
*/
|
|
declare function useIDBKeyval<T>(key: IDBValidKey, initialValue: MaybeRefOrGetter<T>, options?: UseIDBOptions): {
|
|
data: RemovableRef<T>;
|
|
isFinished: Ref<boolean>;
|
|
};
|
|
|
|
export { UseIDBOptions, useIDBKeyval };
|