8000 fix: stricter types · vueuse/vueuse@a086e8b · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit a086e8b

Browse files
antfuantfu
committed
fix: stricter types
1 parent 4a61d33 commit a086e8b

File tree

21 files changed

+122
-122
lines changed

21 files changed

+122
-122
lines changed

‎packages/.test/mount.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { InjectionKey, Ref } from 'vue-demi'
22
import { createApp, defineComponent, h, provide, ref } from 'vue-demi'
33

44
type InstanceType<V> = V extends { new (...arg: any[]): infer X } ? X : never
5-
type VM<V> = InstanceType<V> & { unmount(): void }
5+
type VM<V> = InstanceType<V> & { unmount: () => void }
66

77
export function mount<V>(Comp: V) {
88
const el = document.createElement('div')

‎packages/core/createReusableTemplate/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export type DefineTemplateComponent<
66
Bindings extends object,
77
Slots extends Record<string, Slot | undefined>,
88
> = DefineComponent<{}> & {
9-
new(): { $slots: { default(_: Bindings & { $slots: Slots }): any } }
9+
new(): { $slots: { default: (_: Bindings & { $slots: Slots }) => any } }
1010
}
1111

1212
export type ReuseTemplateComponent<

‎packages/core/createTemplatePromise/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface TemplatePromiseOptions {
5050
export type TemplatePromise<Return, Args extends any[] = []> = DefineComponent<{}> & {
5151
new(): {
5252
$slots: {
53-
default(_: TemplatePromiseProps<Return, Args>): any
53+
default: (_: TemplatePromiseProps<Return, Args>) => any
5454
}
5555
}
5656
} & {

‎packages/core/ssr-handlers.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ import type { Awaitable } from '@vueuse/shared'
33
import type { MaybeElementRef } from './unrefElement'
44

55
export interface StorageLikeAsync {
6-
getItem(key: string): Awaitable<string | null>
7-
setItem(key: string, value: string): Awaitable<void>
8-
removeItem(key: string): Awaitable<void>
6+
getItem: (key: string) => Awaitable<string | null>
7+
setItem: (key: string, value: string) => Awaitable<void>
8+
removeItem: (key: string) => Awaitable<void>
99
}
1010

1111
export interface StorageLike {
12-
getItem(key: string): string | null
13-
setItem(key: string, value: string): void
14-
removeItem(key: string): void
12+
getItem: (key: string) => string | null
13+
setItem: (key: string, value: string) => void
14+
removeItem: (key: string) => void
1515
}
1616

1717
/**

‎packages/core/useBreakpoints/index.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,13 @@ export function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, op
8989
export type UseBreakpointsReturn<K extends string = string> = {
9090
greater: (k: K) => ComputedRef<boolean>
9191
greaterOrEqual: (k: K) => ComputedRef<boolean>
92-
smaller(k: K): ComputedRef<boolean>
92+
smaller: (k: K) => ComputedRef<boolean>
9393
smallerOrEqual: (k: K) => ComputedRef<boolean>
94-
between(a: K, b: K): ComputedRef<boolean>
95-
isGreater(k: K): boolean
96-
isGreaterOrEqual(k: K): boolean
97-
isSmaller(k: K): boolean
98-
isSmallerOrEqual(k: K): boolean
99-
isInBetween(a: K, b: K): boolean
100-
current(): ComputedRef<string[]>
94+
between: (a: K, b: K) => ComputedRef<boolean>
95+
isGreater: (k: K) => boolean
96+
isGreaterOrEqual: (k: K) => boolean
97+
isSmaller: (k: K) => boolean
98+
isSmallerOrEqual: (k: K) => boolean
99+
isInBetween: (a: K, b: K) => boolean
100+
current: () => ComputedRef<string[]>
101101
} & Record<K, ComputedRef<boolean>>

‎packages/core/useEventListener/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import { unrefElement } from '../unrefElement'
66
import { defaultWindow } from '../_configurable'
77

88
interface InferEventTarget<Events> {
9-
addEventListener(event: Events, fn?: any, options?: any): any
10-
removeEventListener(event: Events, fn?: any, options?: any): any
9+
addEventListener: (event: Events, fn?: any, options?: any) => any
10+
removeEventListener: (event: Events, fn?: any, options?: any) => any
1111
}
1212

1313
export type WindowEventName = keyof WindowEventMap

‎packages/core/useFetch/index.ts

Lines changed: 12 additions & 12 deletions
< 10000 td data-grid-cell-id="diff-0db62ed388d474bc80cd69e2ff1593cd6c9719b8794d8f88459a1704e8da25b5-81-81-1" data-selected="false" role="gridcell" style="background-color:var(--diffBlob-additionNum-bgColor, var(--diffBlob-addition-bgColor-num));text-align:center" tabindex="-1" valign="top" class="focusable-grid-cell diff-line-number position-relative left-side">81
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,20 @@ export interface UseFetchReturn<T> {
7272
onFetchFinally: EventHookOn
7373

7474
// methods
75-
get(): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
76-
post(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
77-
put(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
78-
delete(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
79-
patch(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
80-
head(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
81-
options(payload?: MaybeRefOrGetter<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
75+
get: () => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
76+
post: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
77+
put: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
78+
delete: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
79+
patch: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
80+
head: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
+
options: (payload?: MaybeRefOrGetter<unknown>, type?: string) => UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
8282

8383
// type
84-
json<JSON = any>(): UseFetchReturn<JSON> & PromiseLike<UseFetchReturn<JSON>>
85-
text(): UseFetchReturn<string> & PromiseLike<UseFetchReturn<string>>
86-
blob(): UseFetchReturn<Blob> & PromiseLike<UseFetchReturn<Blob>>
87-
arrayBuffer(): UseFetchReturn<ArrayBuffer> & PromiseLike<UseFetchReturn<ArrayBuffer>>
88-
formData(): UseFetchReturn<FormData> & PromiseLike<UseFetchReturn<FormData>>
84+
json: <JSON = any>() => UseFetchReturn<JSON> & PromiseLike<UseFetchReturn<JSON>>
85+
text: () => UseFetchReturn<string> & PromiseLike<UseFetchReturn<string>>
86+
blob: () => UseFetchReturn<Blob> & PromiseLike<UseFetchReturn<Blob>>
87+
arrayBuffer: () => UseFetchReturn<ArrayBuffer> & PromiseLike<UseFetchReturn<ArrayBuffer>>
88+
formData: () => UseFetchReturn<FormData> & PromiseLike<UseFetchReturn<FormData>>
8989
}
9090

9191
type DataType = 'text' | 'json' | 'blob' | 'arrayBuffer' | 'formData'

‎packages/core/useMemoize/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,22 +70,22 @@ export interface MemoizeCache<Key, Value> {
7070
/**
7171
* Get value for key
7272
*/
73-
get (key: Key): Value | undefined
73+
get: (key: Key) => Value | undefined
7474
/**
7575
* Set value for key
7676
*/
77-
set (key: Key, value: Value): void
77+
set: (key: Key, value: Value) => void
7878
/**
7979
* Return flag if key exists
8080
*/
81-
has (key: Key): boolean
81+
has: (key: Key) => boolean
8282
/**
8383
* Delete value for key
8484
*/
85-
delete (key: Key): void
85+
delete: (key: Key) => void
8686
/**
8787
* Clear cache
8888
*/
89-
clear (): void
89+
clear: () => void
9090
}
9191
```

‎packages/core/useMemoize/index.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ export interface UseMemoizeCache<Key, Value> {
1010
/**
1111
* Get value for key
1212
*/
13-
get(key: Key): Value | undefined
13+
get: (key: Key) => Value | undefined
1414
/**
1515
* Set value for key
1616
*/
17-
set(key: Key, value: Value): void
17+
set: (key: Key, value: Value) => void
1818
/**
1919
* Return flag if key exists
2020
*/
21-
has(key: Key): boolean
21+
has: (key: Key) => boolean
2222
/**
2323
* Delete value for key
2424
*/
25-
delete(key: Key): void
25+
delete: (key: Key) => void
2626
/**
2727
* Clear cache
2828
*/
29-
clear(): void
29+
clear: () => void
3030
}
3131

3232
/**
@@ -58,19 +58,19 @@ export interface UseMemoizeReturn<Result, Args extends unknown[]> {
5858
/**
5959
* Call memoized function and update cache
6060
*/
61-
load(...args: Args): Result
61+
load: (...args: Args) => Result
6262
/**
6363
* Delete cache of given arguments
6464
*/
65-
delete(...args: Args): void
65+
delete: (...args: Args) => void
6666
/**
6767
* Clear cache
6868
*/
69-
clear(): void
69+
clear: () => void
7070
/**
7171
* Generate cache key for given arguments
7272
*/
73-
generateKey(...args: Args): CacheKey
73+
generateKey: (...args: Args) => CacheKey
7474
/**
7575
* Cache container
7676
*/

‎packages/core/usePointerLock/index.ts

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,16 @@ import type { MaybeElementRef } from '../unrefElement'
77
import type { ConfigurableDocument } from '../_configurable'
88
import { defaultDocument } from '../_configurable'
99

10-
declare global {
11-
interface PointerLockOptions {
12-
unadjustedMovement?: boolean
13-
}
14-
15-
interface Element {
16-
requestPointerLock(options?: PointerLockOptions): Promise<void> | void
17-
}
18-
}
10+
// declare global {
11+
// interface PointerLockOptions {
12+
// unadjustedMovement?: boolean
13+
// }
14+
// }
1915

2016
type MaybeHTMLElement = HTMLElement | undefined | null
2117

2218
export interface UsePointerLockOptions extends ConfigurableDocument {
23-
pointerLockOptions?: PointerLockOptions
19+
// pointerLockOptions?: PointerLockOptions
2420
}
2521

2622
/**
@@ -31,7 +27,7 @@ export interface UsePointerLockOptions extends ConfigurableDocument {
3127
* @param options
3228
*/
3329
export function usePointerLock(target?: MaybeElementRef<MaybeHTMLElement>, options: UsePointerLockOptions = {}) {
34-
const { document = defaultDocument, pointerLockOptions } = options
30+
const { document = defaultDocument } = options
3531

3632
const isSupported = useSupported(() => document && 'pointerLockElement' in document)
3733

@@ -60,15 +56,18 @@ export function usePointerLock(target?: MaybeElementRef<MaybeHTMLElement>, optio
6056
})
6157
}
6258

63-
async function lock(e: MaybeElementRef<MaybeHTMLElement> | Event, options?: PointerLockOptions) {
59+
async function lock(
60+
e: MaybeElementRef<MaybeHTMLElement> | Event,
61+
// options?: PointerLockOptions,
62+
) {
6463
if (!isSupported.value)
6564
throw new Error('Pointer Lock API is not supported by your browser.')
6665

6766
triggerElement.value = e instanceof Event ? <HTMLElement>e.currentTarget : null
6867
targetElement = e instanceof Event ? unrefElement(target) ?? triggerElement.value : unrefElement(e)
6968
if (!targetElement)
7069
throw new Error('Target element undefined.')
71-
targetElement.requestPointerLock(options ?? pointerLockOptions)
70+
targetElement.requestPointerLock()
7271

7372
return await until(element).toBe(targetElement)
7473
}

‎packages/core/useRefHistory/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,26 +56,26 @@ export interface UseRefHistoryReturn<Raw, Serialized> extends UseManualRefHistor
5656
/**
5757
* Pause change tracking
5858
*/
59-
pause(): void
59+
pause: () => void
6060

6161
/**
6262
* Resume change tracking
6363
*
6464
* @param [commit] if true, a history record will be create after resuming
6565
*/
66-
resume(commit?: boolean): void
66+
resume: (commit?: boolean) => void
6767

6868
/**
6969
* A sugar for auto pause and auto resuming within a function scope
7070
*
7171
* @param fn
7272
*/
73-
batch(fn: (cancel: Fn) => void): void
73+
batch: (fn: (cancel: Fn) => void) => void
7474

7575
/**
7676
* Clear the data and stop the watch
7777
*/
78-
dispose(): void
78+
dispose: () => void
7979
}
8080

8181
/**

‎packages/core/useScreenOrientation/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ export type OrientationType = 'portrait-primary' | 'portrait-secondary' | 'lands
1111
export type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary'
1212

1313
export interface ScreenOrientation extends EventTarget {
14-
lock(orientation: OrientationLockType): Promise<void>
15-
unlock(): void
14+
lock: (orientation: OrientationLockType) => Promise<void>
15+
unlock: () => void
1616
readonly type: OrientationType
1717
readonly angle: number
18-
addEventListener(type: 'change', listener: (this: this, ev: Event) => any, useCapture?: boolean): void
18+
addEventListener: (type: 'change', listener: (this: this, ev: Event) => any, useCapture?: boolean) => void
1919
}
2020

2121
/**

‎packages/core/useSpeechRecognition/types.ts

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ interface SpeechGrammar {
1717

1818
interface SpeechGrammarList {
1919
readonly length: number
20-
addFromString(string: string, weight?: number): void
21-
addFromURI(src: string, weight?: number): void
22-
item(index: number): SpeechGrammar
20+
addFromString: (string: string, weight?: number) => void
21+
addFromURI: (src: string, weight?: number) => void
22+
item: (index: number) => SpeechGrammar
2323
[index: number]: SpeechGrammar
2424
}
2525

@@ -34,17 +34,17 @@ interface SpeechRecognitionEvent extends Event {
3434
}
3535

3636
interface SpeechRecognitionEventMap {
37-
'audioend': Event
38-
'audiostart': Event
39-
'end': Event
40-
'error': SpeechRecognitionErrorEvent
41-
'nomatch': SpeechRecognitionEvent
42-
'result': SpeechRecognitionEvent
43-
'soundend': Event
44-
'soundstart': Event
45-
'speechend': Event
46-
'speechstart': Event
47-
'start': Event
37+
audioend: Event
38+
audiostart: Event
39+
end: Event
40+
error: SpeechRecognitionErrorEvent
41+
nomatch: SpeechRecognitionEvent
42+
result: SpeechRecognitionEvent
43+
soundend: Event
44+
soundstart: Event
45+
speechend: Event
46+
speechstart: Event
47+
start: Event
4848
}
4949

5050
export interface SpeechRecognition extends EventTarget {
@@ -64,11 +64,9 @@ export interface SpeechRecognition extends EventTarget {
6464
onspeechend: ((this: SpeechRecognition, ev: Event) => any) | null
6565
onspeechstart: ((this: SpeechRecognition, ev: Event) => any) | null
6666
onstart: ((this: SpeechRecognition, ev: Event) => any) | null
67-
abort(): void
68-
start(): void
69-
stop(): void
70-
addEventListener<K extends keyof SpeechRecognitionEventMap>(type: K, listener: (this: SpeechRecognition, ev: SpeechRecognitionEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
71-
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
72-
removeEventListener<K extends keyof SpeechRecognitionEventMap>(type: K, listener: (this: SpeechRecognition, ev: SpeechRecognitionEventMap[K]) => any, options?: boolean | EventListenerOptions): void
73-
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
67+
abort: () => void
68+
start: () => void
69+
stop: () => void
70+
addEventListener: (<K extends keyof SpeechRecognitionEventMap>(type: K, listener: (this: SpeechRecognition, ev: SpeechRecognitionEventMap[K]) => any, options?: boolean | AddEventListenerOptions) => void) & ((type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => void)
71+
removeEventListener: (<K extends keyof SpeechRecognitionEventMap>(type: K, listener: (this: SpeechRecognition, ev: SpeechRecognitionEventMap[K]) => any, options?: boolean | EventListenerOptions) => void) & ((type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void)
7472
}

‎packages/core/useStorage/index.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import { defaultWindow } from '../_configurable'
99
import { guessSerializerType } from './guess'
1010

1111
export interface Serializer<T> {
12-
read(raw: string): T
13-
write(value: T): string
12+
read: (raw: string) => T
13+
write: (value: T) => string
1414
}
1515

1616
export interface SerializerAsync<T> {
17-
read(raw: string): Awaitable<T>
18-
write(value: T): Awaitable<string>
17+
read: (raw: string) => Awaitable<T>
18+
write: (value: T) => Awaitable<string>
1919
}
2020

2121
export const StorageSerializers: Record<'boolean' | 'object' | 'number' | 'any' | 'string' | 'map' | 'set' | 'date', Serializer<any>> = {
@@ -199,7 +199,7 @@ export function useStorage<T extends(string | number | boolean | object | null)>
199199
storage!.removeItem(key)
200200
}
201201
else {
202-
const serialized = serializer.write(v)
202+
const serialized = serializer.write(v as any)
203203
const oldValue = storage!.getItem(key)
204204
if (oldValue !== serialized) {
205205
storage!.setItem(key, serialized)

‎packages/core/useTemplateRefsList/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { Ref } from 'vue-demi'
22
import { onBeforeUpdate, ref } from 'vue-demi'
33

44
export type TemplateRefsList<T> = T[] & {
5-
set(el: Object | null): void
5+
set: (el: Object | null) => void
66
}
77

88
export function useTemplateRefsList<T = Element>(): Readonly<Ref<Readonly<TemplateRefsList<T>>>> {

0 commit comments

Comments
 (0)
0