diff --git a/packages/core/useColorMode/index.ts b/packages/core/useColorMode/index.ts index b771e05d1a4..c937425dfbe 100644 --- a/packages/core/useColorMode/index.ts +++ b/packages/core/useColorMode/index.ts @@ -3,14 +3,14 @@ import { computed, ref, watch } from 'vue-demi' import { tryOnMounted } from '@vueuse/shared' import type { StorageLike } from '../ssr-handlers' import { getSSRHandler } from '../ssr-handlers' -import type { StorageOptions } from '../useStorage' +import type { UseStorageOptions } from '../useStorage' import { useStorage } from '../useStorage' import { defaultWindow } from '../_configurable' import { usePreferredDark } from '../usePreferredDark' export type BasicColorSchema = 'light' | 'dark' | 'auto' -export interface UseColorModeOptions extends StorageOptions { +export interface UseColorModeOptions extends UseStorageOptions { /** * CSS Selector for the target element applying to * diff --git a/packages/core/useLocalStorage/index.ts b/packages/core/useLocalStorage/index.ts index e630c763e9b..1fe375fa455 100644 --- a/packages/core/useLocalStorage/index.ts +++ b/packages/core/useLocalStorage/index.ts @@ -1,13 +1,13 @@ import type { MaybeComputedRef, RemovableRef } from '@vueuse/shared' -import type { StorageOptions } from '../useStorage' +import type { UseStorageOptions } from '../useStorage' import { useStorage } from '../useStorage' import { defaultWindow } from '../_configurable' -export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef +export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useLocalStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef /** * Reactive LocalStorage. @@ -20,7 +20,7 @@ export function useLocalStorage(key: string, initialValue: MaybeCom export function useLocalStorage( key: string, initialValue: MaybeComputedRef, - options: StorageOptions = {}, + options: UseStorageOptions = {}, ): RemovableRef { const { window = defaultWindow } = options return useStorage(key, initialValue, window?.localStorage, options) diff --git a/packages/core/useSessionStorage/index.ts b/packages/core/useSessionStorage/index.ts index a1c03bb64f7..31d606e751d 100644 --- a/packages/core/useSessionStorage/index.ts +++ b/packages/core/useSessionStorage/index.ts @@ -1,13 +1,13 @@ import type { MaybeComputedRef, RemovableRef } from '@vueuse/shared' -import type { StorageOptions } from '../useStorage' +import type { UseStorageOptions } from '../useStorage' import { useStorage } from '../useStorage' import { defaultWindow } from '../_configurable' -export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef -export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: StorageOptions): RemovableRef +export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef +export function useSessionStorage(key: string, initialValue: MaybeComputedRef, options?: UseStorageOptions): RemovableRef /** * Reactive SessionStorage. @@ -20,7 +20,7 @@ export function useSessionStorage(key: string, initialValue: MaybeC export function useSessionStorage( key: string, initialValue: MaybeComputedRef, - options: StorageOptions = {}, + options: UseStorageOptions = {}, ): RemovableRef { const { window = defaultWindow } = options return useStorage(key, initialValue, window?.sessionStorage, options) diff --git a/packages/core/useStorage/index.ts b/packages/core/useStorage/index.ts index 4f470a79e79..f4eb796b9ce 100644 --- a/packages/core/useStorage/index.ts +++ b/packages/core/useStorage/index.ts @@ -53,7 +53,7 @@ export const StorageSerializers: Record<'boolean' | 'object' | 'number' | 'any' }, } -export interface StorageOptions extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush { +export interface UseStorageOptions extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush { /** * Watch for deep changes * @@ -95,11 +95,11 @@ export interface StorageOptions extends ConfigurableEventFilter, Configurable shallow?: boolean } -export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: StorageOptions): RemovableRef -export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: StorageOptions): RemovableRef -export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: StorageOptions): RemovableRef -export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: StorageOptions): RemovableRef -export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: StorageOptions): RemovableRef +export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: UseStorageOptions): RemovableRef +export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: UseStorageOptions): RemovableRef +export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: UseStorageOptions): RemovableRef +export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: UseStorageOptions): RemovableRef +export function useStorage(key: string, initialValue: MaybeComputedRef, storage?: StorageLike, options?: UseStorageOptions): RemovableRef /** * Reactive LocalStorage/SessionStorage. @@ -114,7 +114,7 @@ export function useStorage key: string, initialValue: MaybeComputedRef, storage: StorageLike | undefined, - options: StorageOptions = {}, + options: UseStorageOptions = {}, ): RemovableRef { const { flush = 'pre', diff --git a/packages/core/useStorageAsync/index.ts b/packages/core/useStorageAsync/index.ts index 9fac08350c6..9c362f2f973 100644 --- a/packages/core/useStorageAsync/index.ts +++ b/packages/core/useStorageAsync/index.ts @@ -4,13 +4,13 @@ import type { Ref } from 'vue-demi' import { ref, shallowRef } from 'vue-demi' import type { StorageLikeAsync } from '../ssr-handlers' import { getSSRHandler } from '../ssr-handlers' -import type { SerializerAsync, StorageOptions } from '../useStorage' +import type { SerializerAsync, UseStorageOptions } from '../useStorage' import { StorageSerializers } from '../useStorage' import { useEventListener } from '../useEventListener' import { guessSerializerType } from '../useStorage/guess' import { defaultWindow } from '../_configurable' -export interface StorageAsyncOptions extends Omit, 'serializer'> { +export interface StorageAsyncOptions extends Omit, 'serializer'> { /** * Custom data serialization */