Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(useStorage)!: rename type StorageOptions to UseStorageOptions #1867

Merged
merged 1 commit into from Jul 12, 2022
Merged

fix(useStorage)!: rename type StorageOptions to UseStorageOptions #1867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/core/useColorMode/index.ts
View file
Open in desktop
Expand Up @@ -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
*
Expand Down
14 changes: 7 additions & 7 deletions packages/core/useLocalStorage/index.ts
View file
Open in desktop
@@ -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.
Expand All @@ -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)
Expand Down
14 changes: 7 additions & 7 deletions packages/core/useSessionStorage/index.ts
View file
Open in desktop
@@ -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.
Expand All @@ -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)
Expand Down
14 changes: 7 additions & 7 deletions packages/core/useStorage/index.ts
View file
Open in desktop
Expand Up @@ -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
*
Expand Down Expand Up @@ -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.
Expand All @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions packages/core/useStorageAsync/index.ts
View file
Open in desktop
Expand Up @@ -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
*/
Expand Down