Warp/node_modules/@vueuse/integrations/useIDBKeyval.d.cts

44 lines
1 KiB
TypeScript
Raw Normal View History

2024-01-05 12:14:38 +00:00
import { ConfigurableFlush, RemovableRef, MaybeRefOrGetter } 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;
}
interface UseIDBKeyvalReturn<T> {
data: RemovableRef<T>;
isFinished: Ref<boolean>;
set(value: T): Promise<void>;
}
/**
*
* @param key
* @param initialValue
* @param options
*/
declare function useIDBKeyval<T>(key: IDBValidKey, initialValue: MaybeRefOrGetter<T>, options?: UseIDBOptions): UseIDBKeyvalReturn<T>;
export { type UseIDBKeyvalReturn, type UseIDBOptions, useIDBKeyval };