fix(useStorage)!: rename type StorageOptions to UseStorageOptions (…

…#1867)
vueuse · Jul 12, 2022 · 499f60d · 499f60d
1 parent 99e073f
commit 499f60d
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 25 deletions.
diff --git 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<T extends string = BasicColorSchema> extends StorageOptions<T | BasicColorSchema> {
+export interface UseColorModeOptions<T extends string = BasicColorSchema> extends UseStorageOptions<T | BasicColorSchema> {
   /**
    * CSS Selector for the target element applying to
    *

diff --git 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<string>, options?: StorageOptions<string>): RemovableRef<string>
-export function useLocalStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: StorageOptions<boolean>): RemovableRef<boolean>
-export function useLocalStorage(key: string, initialValue: MaybeComputedRef<number>, options?: StorageOptions<number>): RemovableRef<number>
-export function useLocalStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: StorageOptions<T>): RemovableRef<T>
-export function useLocalStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: StorageOptions<T>): RemovableRef<T>
+export function useLocalStorage(key: string, initialValue: MaybeComputedRef<string>, options?: UseStorageOptions<string>): RemovableRef<string>
+export function useLocalStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
+export function useLocalStorage(key: string, initialValue: MaybeComputedRef<number>, options?: UseStorageOptions<number>): RemovableRef<number>
+export function useLocalStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: UseStorageOptions<T>): RemovableRef<T>
+export function useLocalStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: UseStorageOptions<T>): RemovableRef<T>
 
 /**
  * Reactive LocalStorage.
@@ -20,7 +20,7 @@ export function useLocalStorage<T = unknown>(key: string, initialValue: MaybeCom
 export function useLocalStorage<T extends(string | number | boolean | object | null)>(
   key: string,
   initialValue: MaybeComputedRef<T>,
-  options: StorageOptions<T> = {},
+  options: UseStorageOptions<T> = {},
 ): RemovableRef<any> {
   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
@@ -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<string>, options?: StorageOptions<string>): RemovableRef<string>
-export function useSessionStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: StorageOptions<boolean>): RemovableRef<boolean>
-export function useSessionStorage(key: string, initialValue: MaybeComputedRef<number>, options?: StorageOptions<number>): RemovableRef<number>
-export function useSessionStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: StorageOptions<T>): RemovableRef<T>
-export function useSessionStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: StorageOptions<T>): RemovableRef<T>
+export function useSessionStorage(key: string, initialValue: MaybeComputedRef<string>, options?: UseStorageOptions<string>): RemovableRef<string>
+export function useSessionStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
+export function useSessionStorage(key: string, initialValue: MaybeComputedRef<number>, options?: UseStorageOptions<number>): RemovableRef<number>
+export function useSessionStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: UseStorageOptions<T>): RemovableRef<T>
+export function useSessionStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: UseStorageOptions<T>): RemovableRef<T>
 
 /**
  * Reactive SessionStorage.
@@ -20,7 +20,7 @@ export function useSessionStorage<T = unknown>(key: string, initialValue: MaybeC
 export function useSessionStorage<T extends(string | number | boolean | object | null)>(
   key: string,
   initialValue: MaybeComputedRef<T>,
-  options: StorageOptions<T> = {},
+  options: UseStorageOptions<T> = {},
 ): RemovableRef<any> {
   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
@@ -53,7 +53,7 @@ export const StorageSerializers: Record<'boolean' | 'object' | 'number' | 'any'
   },
 }
 
-export interface StorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush {
+export interface UseStorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush {
   /**
    * Watch for deep changes
    *
@@ -95,11 +95,11 @@ export interface StorageOptions<T> extends ConfigurableEventFilter, Configurable
   shallow?: boolean
 }
 
-export function useStorage(key: string, initialValue: MaybeComputedRef<string>, storage?: StorageLike, options?: StorageOptions<string>): RemovableRef<string>
-export function useStorage(key: string, initialValue: MaybeComputedRef<boolean>, storage?: StorageLike, options?: StorageOptions<boolean>): RemovableRef<boolean>
-export function useStorage(key: string, initialValue: MaybeComputedRef<number>, storage?: StorageLike, options?: StorageOptions<number>): RemovableRef<number>
-export function useStorage<T>(key: string, initialValue: MaybeComputedRef<T>, storage?: StorageLike, options?: StorageOptions<T>): RemovableRef<T>
-export function useStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, storage?: StorageLike, options?: StorageOptions<T>): RemovableRef<T>
+export function useStorage(key: string, initialValue: MaybeComputedRef<string>, storage?: StorageLike, options?: UseStorageOptions<string>): RemovableRef<string>
+export function useStorage(key: string, initialValue: MaybeComputedRef<boolean>, storage?: StorageLike, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
+export function useStorage(key: string, initialValue: MaybeComputedRef<number>, storage?: StorageLike, options?: UseStorageOptions<number>): RemovableRef<number>
+export function useStorage<T>(key: string, initialValue: MaybeComputedRef<T>, storage?: StorageLike, options?: UseStorageOptions<T>): RemovableRef<T>
+export function useStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, storage?: StorageLike, options?: UseStorageOptions<T>): RemovableRef<T>
 
 /**
  * Reactive LocalStorage/SessionStorage.
@@ -114,7 +114,7 @@ export function useStorage<T extends(string | number | boolean | object | null)>
   key: string,
   initialValue: MaybeComputedRef<T>,
   storage: StorageLike | undefined,
-  options: StorageOptions<T> = {},
+  options: UseStorageOptions<T> = {},
 ): RemovableRef<T> {
   const {
     flush = 'pre',

diff --git 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<T> extends Omit<StorageOptions<T>, 'serializer'> {
+export interface StorageAsyncOptions<T> extends Omit<UseStorageOptions<T>, 'serializer'> {
   /**
    * Custom data serialization
    */