@vueuse/shared 14.0.0-alpha.3 → 14.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +253 -239
- package/dist/index.iife.js +1771 -1773
- package/dist/index.iife.min.js +1 -1
- package/dist/index.js +14 -16
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import * as vue0 from "vue";
|
|
2
|
-
import { ComputedGetter, ComputedRef, InjectionKey, MaybeRef, MaybeRefOrGetter, Ref, ShallowRef, ShallowUnwrapRef as ShallowUnwrapRef$1, ToRef, ToRefs, UnwrapNestedRefs, UnwrapRef, WatchCallback, WatchHandle, WatchOptions, WatchOptionsBase, WatchSource, WatchStopHandle, WritableComputedOptions, WritableComputedRef, getCurrentInstance, inject } from "vue";
|
|
2
|
+
import { ComponentInternalInstance, ComputedGetter, ComputedRef, InjectionKey, MaybeRef, MaybeRefOrGetter, Ref, ShallowRef, ShallowUnwrapRef as ShallowUnwrapRef$1, ToRef, ToRefs, UnwrapNestedRefs, UnwrapRef, WatchCallback, WatchHandle, WatchOptions, WatchOptionsBase, WatchSource, WatchStopHandle, WritableComputedOptions, WritableComputedRef, getCurrentInstance, inject } from "vue";
|
|
3
3
|
|
|
4
4
|
//#region computedEager/index.d.ts
|
|
5
5
|
type ComputedEagerOptions = WatchOptionsBase;
|
|
6
|
-
type ComputedEagerReturn<T = any> = Readonly<ShallowRef<T>>;
|
|
6
|
+
type ComputedEagerReturn<T$1 = any> = Readonly<ShallowRef<T$1>>;
|
|
7
7
|
/**
|
|
8
8
|
*
|
|
9
9
|
* @deprecated This function will be removed in future version.
|
|
@@ -17,7 +17,7 @@ type ComputedEagerReturn<T = any> = Readonly<ShallowRef<T>>;
|
|
|
17
17
|
* @param options WatchOptionsBase
|
|
18
18
|
* @returns readonly shallowRef
|
|
19
19
|
*/
|
|
20
|
-
declare function computedEager<T>(fn: () => T, options?: ComputedEagerOptions): ComputedEagerReturn<T>;
|
|
20
|
+
declare function computedEager<T$1>(fn: () => T$1, options?: ComputedEagerOptions): ComputedEagerReturn<T$1>;
|
|
21
21
|
/** @deprecated use `computedEager` instead */
|
|
22
22
|
declare const eagerComputed: typeof computedEager;
|
|
23
23
|
//#endregion
|
|
@@ -28,11 +28,11 @@ interface ComputedWithControlRefExtra {
|
|
|
28
28
|
*/
|
|
29
29
|
trigger: () => void;
|
|
30
30
|
}
|
|
31
|
-
interface ComputedRefWithControl<T> extends ComputedRef<T>, ComputedWithControlRefExtra {}
|
|
32
|
-
interface WritableComputedRefWithControl<T> extends WritableComputedRef<T>, ComputedWithControlRefExtra {}
|
|
33
|
-
type ComputedWithControlRef<T = any> = ComputedRefWithControl<T> | WritableComputedRefWithControl<T>;
|
|
34
|
-
declare function computedWithControl<T, S>(source: WatchSource<S> | WatchSource<S>[], fn: ComputedGetter<T>, options?: WatchOptions): ComputedRefWithControl<T>;
|
|
35
|
-
declare function computedWithControl<T, S>(source: WatchSource<S> | WatchSource<S>[], fn: WritableComputedOptions<T>, options?: WatchOptions): WritableComputedRefWithControl<T>;
|
|
31
|
+
interface ComputedRefWithControl<T$1> extends ComputedRef<T$1>, ComputedWithControlRefExtra {}
|
|
32
|
+
interface WritableComputedRefWithControl<T$1> extends WritableComputedRef<T$1>, ComputedWithControlRefExtra {}
|
|
33
|
+
type ComputedWithControlRef<T$1 = any> = ComputedRefWithControl<T$1> | WritableComputedRefWithControl<T$1>;
|
|
34
|
+
declare function computedWithControl<T$1, S$1>(source: WatchSource<S$1> | WatchSource<S$1>[], fn: ComputedGetter<T$1>, options?: WatchOptions): ComputedRefWithControl<T$1>;
|
|
35
|
+
declare function computedWithControl<T$1, S$1>(source: WatchSource<S$1> | WatchSource<S$1>[], fn: WritableComputedOptions<T$1>, options?: WatchOptions): WritableComputedRefWithControl<T$1>;
|
|
36
36
|
/** @deprecated use `computedWithControl` instead */
|
|
37
37
|
declare const controlledComputed: typeof computedWithControl;
|
|
38
38
|
//#endregion
|
|
@@ -40,7 +40,7 @@ declare const controlledComputed: typeof computedWithControl;
|
|
|
40
40
|
/**
|
|
41
41
|
* Void function
|
|
42
42
|
*/
|
|
43
|
-
type Fn
|
|
43
|
+
type Fn = () => void;
|
|
44
44
|
/**
|
|
45
45
|
* Any function
|
|
46
46
|
*/
|
|
@@ -48,14 +48,14 @@ type AnyFn = (...args: any[]) => any;
|
|
|
48
48
|
/**
|
|
49
49
|
* A ref that allow to set null or undefined
|
|
50
50
|
*/
|
|
51
|
-
type RemovableRef<T> = Omit<Ref<T>, 'value'> & {
|
|
52
|
-
get value(): T;
|
|
53
|
-
set value(value: T | null | undefined);
|
|
51
|
+
type RemovableRef<T$1> = Omit<Ref<T$1>, 'value'> & {
|
|
52
|
+
get value(): T$1;
|
|
53
|
+
set value(value: T$1 | null | undefined);
|
|
54
54
|
};
|
|
55
55
|
/**
|
|
56
56
|
* Maybe it's a computed ref, or a readonly value, or a getter function
|
|
57
57
|
*/
|
|
58
|
-
type ReadonlyRefOrGetter<T> = ComputedRef<T> | (() => T);
|
|
58
|
+
type ReadonlyRefOrGetter<T$1> = ComputedRef<T$1> | (() => T$1);
|
|
59
59
|
/**
|
|
60
60
|
* Make all the nested attributes of an object or array to MaybeRef<T>
|
|
61
61
|
*
|
|
@@ -65,23 +65,23 @@ type ReadonlyRefOrGetter<T> = ComputedRef<T> | (() => T);
|
|
|
65
65
|
* UnwrapRef<DeepMaybeRef<T>> === T
|
|
66
66
|
* ```
|
|
67
67
|
*/
|
|
68
|
-
type DeepMaybeRef<T> = T extends Ref<infer V> ? MaybeRef<V> : T extends Array<any> | object ? { [K in keyof T]: DeepMaybeRef<T[K]> } : MaybeRef<T>;
|
|
69
|
-
type Arrayable<T> = T[] | T;
|
|
68
|
+
type DeepMaybeRef<T$1> = T$1 extends Ref<infer V> ? MaybeRef<V> : T$1 extends Array<any> | object ? { [K in keyof T$1]: DeepMaybeRef<T$1[K]> } : MaybeRef<T$1>;
|
|
69
|
+
type Arrayable<T$1> = T$1[] | T$1;
|
|
70
70
|
/**
|
|
71
71
|
* Infers the element type of an array
|
|
72
72
|
*/
|
|
73
|
-
type ElementOf<T> = T extends (infer E)[] ? E : never;
|
|
74
|
-
type ShallowUnwrapRef<T> = T extends Ref<infer P> ? P : T;
|
|
75
|
-
type Awaitable<T> = Promise<T> | T;
|
|
76
|
-
type ArgumentsType<T> = T extends ((...args: infer U) => any) ? U : never;
|
|
73
|
+
type ElementOf<T$1> = T$1 extends (infer E)[] ? E : never;
|
|
74
|
+
type ShallowUnwrapRef<T$1> = T$1 extends Ref<infer P> ? P : T$1;
|
|
75
|
+
type Awaitable<T$1> = Promise<T$1> | T$1;
|
|
76
|
+
type ArgumentsType<T$1> = T$1 extends ((...args: infer U) => any) ? U : never;
|
|
77
77
|
/**
|
|
78
78
|
* Compatible with versions below TypeScript 4.5 Awaited
|
|
79
79
|
*/
|
|
80
|
-
type Awaited<T> = T extends null | undefined ? T : T extends object & {
|
|
80
|
+
type Awaited<T$1> = T$1 extends null | undefined ? T$1 : T$1 extends object & {
|
|
81
81
|
then: (onfulfilled: infer F, ...args: infer _) => any;
|
|
82
|
-
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited<V> : never : T;
|
|
83
|
-
type Promisify<T> = Promise<Awaited<T>>;
|
|
84
|
-
type PromisifyFn<T extends AnyFn> = (...args: ArgumentsType<T>) => Promisify<ReturnType<T>>;
|
|
82
|
+
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited<V> : never : T$1;
|
|
83
|
+
type Promisify<T$1> = Promise<Awaited<T$1>>;
|
|
84
|
+
type PromisifyFn<T$1 extends AnyFn> = (...args: ArgumentsType<T$1>) => Promisify<ReturnType<T$1>>;
|
|
85
85
|
interface Pausable {
|
|
86
86
|
/**
|
|
87
87
|
* A ref indicate whether a pausable instance is active
|
|
@@ -90,11 +90,11 @@ interface Pausable {
|
|
|
90
90
|
/**
|
|
91
91
|
* Temporary pause the effect from executing
|
|
92
92
|
*/
|
|
93
|
-
pause: Fn
|
|
93
|
+
pause: Fn;
|
|
94
94
|
/**
|
|
95
95
|
* Resume the effects
|
|
96
96
|
*/
|
|
97
|
-
resume: Fn
|
|
97
|
+
resume: Fn;
|
|
98
98
|
}
|
|
99
99
|
interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
100
100
|
/**
|
|
@@ -104,7 +104,7 @@ interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
|
104
104
|
/**
|
|
105
105
|
* Stop the effect from executing
|
|
106
106
|
*/
|
|
107
|
-
stop: Fn
|
|
107
|
+
stop: Fn;
|
|
108
108
|
/**
|
|
109
109
|
* Start the effects
|
|
110
110
|
*/
|
|
@@ -129,14 +129,14 @@ interface ConfigurableFlushSync {
|
|
|
129
129
|
flush?: WatchOptionFlush;
|
|
130
130
|
}
|
|
131
131
|
type MultiWatchSources = (WatchSource<unknown> | object)[];
|
|
132
|
-
type MapSources<T> = { [K in keyof T]: T[K] extends WatchSource<infer V> ? V : never };
|
|
133
|
-
type MapOldSources<T, Immediate> = { [K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : never };
|
|
134
|
-
type Mutable<T> = { -readonly [P in keyof T]: T[P] };
|
|
135
|
-
type IfAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
|
|
132
|
+
type MapSources<T$1> = { [K in keyof T$1]: T$1[K] extends WatchSource<infer V> ? V : never };
|
|
133
|
+
type MapOldSources<T$1, Immediate> = { [K in keyof T$1]: T$1[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : never };
|
|
134
|
+
type Mutable<T$1> = { -readonly [P in keyof T$1]: T$1[P] };
|
|
135
|
+
type IfAny<T$1, Y, N> = 0 extends (1 & T$1) ? Y : N;
|
|
136
136
|
/**
|
|
137
137
|
* will return `true` if `T` is `any`, or `false` otherwise
|
|
138
138
|
*/
|
|
139
|
-
type IsAny<T> = IfAny<T, true, false>;
|
|
139
|
+
type IsAny<T$1> = IfAny<T$1, true, false>;
|
|
140
140
|
/**
|
|
141
141
|
* Universal timer handle that works in both browser and Node.js environments
|
|
142
142
|
*/
|
|
@@ -144,19 +144,19 @@ type TimerHandle = ReturnType<typeof setTimeout> | undefined;
|
|
|
144
144
|
type InstanceProxy = NonNullable<NonNullable<ReturnType<typeof getCurrentInstance>>['proxy']>;
|
|
145
145
|
//#endregion
|
|
146
146
|
//#region createEventHook/index.d.ts
|
|
147
|
-
type Callback<T> = IsAny<T> extends true ? (...param: any) => void : ([T] extends [void] ? (...param: unknown[]) => void : [T] extends [any[]] ? (...param: T) => void : (...param: [T, ...unknown[]]) => void);
|
|
148
|
-
type EventHookOn<T = any> = (fn: Callback<T>) => {
|
|
147
|
+
type Callback<T$1> = IsAny<T$1> extends true ? (...param: any) => void : ([T$1] extends [void] ? (...param: unknown[]) => void : [T$1] extends [any[]] ? (...param: T$1) => void : (...param: [T$1, ...unknown[]]) => void);
|
|
148
|
+
type EventHookOn<T$1 = any> = (fn: Callback<T$1>) => {
|
|
149
149
|
off: () => void;
|
|
150
150
|
};
|
|
151
|
-
type EventHookOff<T = any> = (fn: Callback<T>) => void;
|
|
152
|
-
type EventHookTrigger<T = any> = (...param: Parameters<Callback<T>>) => Promise<unknown[]>;
|
|
153
|
-
interface EventHook<T = any> {
|
|
154
|
-
on: EventHookOn<T>;
|
|
155
|
-
off: EventHookOff<T>;
|
|
156
|
-
trigger: EventHookTrigger<T>;
|
|
151
|
+
type EventHookOff<T$1 = any> = (fn: Callback<T$1>) => void;
|
|
152
|
+
type EventHookTrigger<T$1 = any> = (...param: Parameters<Callback<T$1>>) => Promise<unknown[]>;
|
|
153
|
+
interface EventHook<T$1 = any> {
|
|
154
|
+
on: EventHookOn<T$1>;
|
|
155
|
+
off: EventHookOff<T$1>;
|
|
156
|
+
trigger: EventHookTrigger<T$1>;
|
|
157
157
|
clear: () => void;
|
|
158
158
|
}
|
|
159
|
-
type EventHookReturn<T> = EventHook<T>;
|
|
159
|
+
type EventHookReturn<T$1> = EventHook<T$1>;
|
|
160
160
|
/**
|
|
161
161
|
* Utility for creating event hooks
|
|
162
162
|
*
|
|
@@ -164,7 +164,7 @@ type EventHookReturn<T> = EventHook<T>;
|
|
|
164
164
|
*
|
|
165
165
|
* @__NO_SIDE_EFFECTS__
|
|
166
166
|
*/
|
|
167
|
-
declare function createEventHook<T = any>(): EventHookReturn<T>;
|
|
167
|
+
declare function createEventHook<T$1 = any>(): EventHookReturn<T$1>;
|
|
168
168
|
//#endregion
|
|
169
169
|
//#region utils/filters.d.ts
|
|
170
170
|
type FunctionArgs<Args extends any[] = any[], Return = void> = (...args: Args) => Return;
|
|
@@ -198,7 +198,7 @@ interface DebounceFilterOptions {
|
|
|
198
198
|
/**
|
|
199
199
|
* @internal
|
|
200
200
|
*/
|
|
201
|
-
declare function createFilterWrapper<T extends AnyFn>(filter: EventFilter, fn: T): (this: any, ...args: ArgumentsType<T>) => Promise<Awaited<ReturnType<T>>>;
|
|
201
|
+
declare function createFilterWrapper<T$1 extends AnyFn>(filter: EventFilter, fn: T$1): (this: any, ...args: ArgumentsType<T$1>) => Promise<Awaited<ReturnType<T$1>>>;
|
|
202
202
|
declare const bypassFilter: EventFilter;
|
|
203
203
|
/**
|
|
204
204
|
* Create an EventFilter that debounce the events
|
|
@@ -247,9 +247,9 @@ declare function pausableFilter(extendFilter?: EventFilter, options?: PausableFi
|
|
|
247
247
|
//#endregion
|
|
248
248
|
//#region utils/general.d.ts
|
|
249
249
|
declare function promiseTimeout(ms: number, throwOnTimeout?: boolean, reason?: string): Promise<void>;
|
|
250
|
-
declare function identity<T>(arg: T): T;
|
|
251
|
-
interface SingletonPromiseReturn<T> {
|
|
252
|
-
(): Promise<T>;
|
|
250
|
+
declare function identity<T$1>(arg: T$1): T$1;
|
|
251
|
+
interface SingletonPromiseReturn<T$1> {
|
|
252
|
+
(): Promise<T$1>;
|
|
253
253
|
/**
|
|
254
254
|
* Reset current staled promise.
|
|
255
255
|
* await it to have proper shutdown.
|
|
@@ -268,8 +268,8 @@ interface SingletonPromiseReturn<T> {
|
|
|
268
268
|
* await promise() // and be resolved together
|
|
269
269
|
* ```
|
|
270
270
|
*/
|
|
271
|
-
declare function createSingletonPromise<T>(fn: () => Promise<T>): SingletonPromiseReturn<T>;
|
|
272
|
-
declare function invoke<T>(fn: () => T): T;
|
|
271
|
+
declare function createSingletonPromise<T$1>(fn: () => Promise<T$1>): SingletonPromiseReturn<T$1>;
|
|
272
|
+
declare function invoke<T$1>(fn: () => T$1): T$1;
|
|
273
273
|
declare function containsProp(obj: object, ...props: string[]): boolean;
|
|
274
274
|
/**
|
|
275
275
|
* Increase string a value with unit
|
|
@@ -287,14 +287,14 @@ declare function pxValue(px: string): number;
|
|
|
287
287
|
/**
|
|
288
288
|
* Create a new subset object by giving keys
|
|
289
289
|
*/
|
|
290
|
-
declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
|
|
290
|
+
declare function objectPick<O extends object, T$1 extends keyof O>(obj: O, keys: T$1[], omitUndefined?: boolean): Pick<O, T$1>;
|
|
291
291
|
/**
|
|
292
292
|
* Create a new subset object by omit giving keys
|
|
293
293
|
*/
|
|
294
|
-
declare function objectOmit<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Omit<O, T>;
|
|
295
|
-
declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
|
|
296
|
-
declare function toArray<T>(value: T | readonly T[]): readonly T[];
|
|
297
|
-
declare function toArray<T>(value: T | T[]): T[];
|
|
294
|
+
declare function objectOmit<O extends object, T$1 extends keyof O>(obj: O, keys: T$1[], omitUndefined?: boolean): Omit<O, T$1>;
|
|
295
|
+
declare function objectEntries<T$1 extends object>(obj: T$1): Array<[keyof T$1, T$1[keyof T$1]]>;
|
|
296
|
+
declare function toArray<T$1>(value: T$1 | readonly T$1[]): readonly T$1[];
|
|
297
|
+
declare function toArray<T$1>(value: T$1 | T$1[]): T$1[];
|
|
298
298
|
//#endregion
|
|
299
299
|
//#region utils/is.d.ts
|
|
300
300
|
declare const isClient: boolean;
|
|
@@ -316,10 +316,10 @@ declare const hyphenate: (str: string) => string;
|
|
|
316
316
|
declare const camelize: (str: string) => string;
|
|
317
317
|
//#endregion
|
|
318
318
|
//#region utils/vue.d.ts
|
|
319
|
-
declare function getLifeCycleTarget(target?:
|
|
319
|
+
declare function getLifeCycleTarget(target?: ComponentInternalInstance | null): ComponentInternalInstance | null;
|
|
320
320
|
//#endregion
|
|
321
321
|
//#region createGlobalState/index.d.ts
|
|
322
|
-
type CreateGlobalStateReturn<Fn extends AnyFn = AnyFn> = Fn;
|
|
322
|
+
type CreateGlobalStateReturn<Fn$1 extends AnyFn = AnyFn> = Fn$1;
|
|
323
323
|
/**
|
|
324
324
|
* Keep states in the global scope to be reusable across Vue instances.
|
|
325
325
|
*
|
|
@@ -328,9 +328,23 @@ type CreateGlobalStateReturn<Fn extends AnyFn = AnyFn> = Fn;
|
|
|
328
328
|
*
|
|
329
329
|
* @__NO_SIDE_EFFECTS__
|
|
330
330
|
*/
|
|
331
|
-
declare function createGlobalState<Fn extends AnyFn>(stateFactory: Fn): CreateGlobalStateReturn<Fn>;
|
|
331
|
+
declare function createGlobalState<Fn$1 extends AnyFn>(stateFactory: Fn$1): CreateGlobalStateReturn<Fn$1>;
|
|
332
332
|
//#endregion
|
|
333
333
|
//#region createInjectionState/index.d.ts
|
|
334
|
+
type CreateInjectionStateReturn<Arguments extends Array<any>, Return> = Readonly<[
|
|
335
|
+
/**
|
|
336
|
+
* Call this function in a provider component to create and provide the state.
|
|
337
|
+
*
|
|
338
|
+
* @param args Arguments passed to the composable
|
|
339
|
+
* @returns The state returned by the composable
|
|
340
|
+
*/
|
|
341
|
+
useProvidingState: (...args: Arguments) => Return,
|
|
342
|
+
/**
|
|
343
|
+
* Call this function in a consumer component to inject the state.
|
|
344
|
+
*
|
|
345
|
+
* @returns The injected state, or `undefined` if not provided and no default value was set.
|
|
346
|
+
*/
|
|
347
|
+
useInjectedState: () => Return | undefined]>;
|
|
334
348
|
interface CreateInjectionStateOptions<Return> {
|
|
335
349
|
/**
|
|
336
350
|
* Custom injectionKey for InjectionState
|
|
@@ -348,11 +362,11 @@ interface CreateInjectionStateOptions<Return> {
|
|
|
348
362
|
*
|
|
349
363
|
* @__NO_SIDE_EFFECTS__
|
|
350
364
|
*/
|
|
351
|
-
declare function createInjectionState<Arguments extends Array<any>, Return>(composable: (...args: Arguments) => Return, options?: CreateInjectionStateOptions<Return>):
|
|
365
|
+
declare function createInjectionState<Arguments extends Array<any>, Return>(composable: (...args: Arguments) => Return, options?: CreateInjectionStateOptions<Return>): CreateInjectionStateReturn<Arguments, Return>;
|
|
352
366
|
//#endregion
|
|
353
367
|
//#region createRef/index.d.ts
|
|
354
|
-
type CreateRefReturn<T = any, D extends boolean = false> = ShallowOrDeepRef<T, D>;
|
|
355
|
-
type ShallowOrDeepRef<T = any, D extends boolean = false> = D extends true ? Ref<T> : ShallowRef<T>;
|
|
368
|
+
type CreateRefReturn<T$1 = any, D extends boolean = false> = ShallowOrDeepRef<T$1, D>;
|
|
369
|
+
type ShallowOrDeepRef<T$1 = any, D extends boolean = false> = D extends true ? Ref<T$1> : ShallowRef<T$1>;
|
|
356
370
|
/**
|
|
357
371
|
* Returns a `deepRef` or `shallowRef` depending on the `deep` param.
|
|
358
372
|
*
|
|
@@ -368,10 +382,10 @@ type ShallowOrDeepRef<T = any, D extends boolean = false> = D extends true ? Ref
|
|
|
368
382
|
*
|
|
369
383
|
* @__NO_SIDE_EFFECTS__
|
|
370
384
|
*/
|
|
371
|
-
declare function createRef<T = any, D extends boolean = false>(value: T, deep?: D): CreateRefReturn<T, D>;
|
|
385
|
+
declare function createRef<T$1 = any, D extends boolean = false>(value: T$1, deep?: D): CreateRefReturn<T$1, D>;
|
|
372
386
|
//#endregion
|
|
373
387
|
//#region createSharedComposable/index.d.ts
|
|
374
|
-
type SharedComposableReturn<T extends AnyFn = AnyFn> = T;
|
|
388
|
+
type SharedComposableReturn<T$1 extends AnyFn = AnyFn> = T$1;
|
|
375
389
|
/**
|
|
376
390
|
* Make a composable function usable with multiple Vue instances.
|
|
377
391
|
*
|
|
@@ -379,10 +393,10 @@ type SharedComposableReturn<T extends AnyFn = AnyFn> = T;
|
|
|
379
393
|
*
|
|
380
394
|
* @__NO_SIDE_EFFECTS__
|
|
381
395
|
*/
|
|
382
|
-
declare function createSharedComposable<Fn extends AnyFn>(composable: Fn): SharedComposableReturn<Fn>;
|
|
396
|
+
declare function createSharedComposable<Fn$1 extends AnyFn>(composable: Fn$1): SharedComposableReturn<Fn$1>;
|
|
383
397
|
//#endregion
|
|
384
398
|
//#region extendRef/index.d.ts
|
|
385
|
-
type ExtendRefReturn<T = any> = Ref<T>;
|
|
399
|
+
type ExtendRefReturn<T$1 = any> = Ref<T$1>;
|
|
386
400
|
interface ExtendRefOptions<Unwrap extends boolean = boolean> {
|
|
387
401
|
/**
|
|
388
402
|
* Is the extends properties enumerable
|
|
@@ -400,18 +414,18 @@ interface ExtendRefOptions<Unwrap extends boolean = boolean> {
|
|
|
400
414
|
/**
|
|
401
415
|
* Overload 1: Unwrap set to false
|
|
402
416
|
*/
|
|
403
|
-
declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R, extend: Extend, options?: Options): ShallowUnwrapRef$1<Extend> & R;
|
|
417
|
+
declare function extendRef<R$1 extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R$1, extend: Extend, options?: Options): ShallowUnwrapRef$1<Extend> & R$1;
|
|
404
418
|
/**
|
|
405
419
|
* Overload 2: Unwrap unset or set to true
|
|
406
420
|
*/
|
|
407
|
-
declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R, extend: Extend, options?: Options): Extend & R;
|
|
421
|
+
declare function extendRef<R$1 extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R$1, extend: Extend, options?: Options): Extend & R$1;
|
|
408
422
|
//#endregion
|
|
409
423
|
//#region get/index.d.ts
|
|
410
424
|
/**
|
|
411
425
|
* Shorthand for accessing `ref.value`
|
|
412
426
|
*/
|
|
413
|
-
declare function get<T>(ref: MaybeRef<T>): T;
|
|
414
|
-
declare function get<T, K extends keyof T>(ref: MaybeRef<T>, key: K): T[K];
|
|
427
|
+
declare function get<T$1>(ref: MaybeRef<T$1>): T$1;
|
|
428
|
+
declare function get<T$1, K$1 extends keyof T$1>(ref: MaybeRef<T$1>, key: K$1): T$1[K$1];
|
|
415
429
|
//#endregion
|
|
416
430
|
//#region injectLocal/index.d.ts
|
|
417
431
|
/**
|
|
@@ -429,15 +443,15 @@ declare const injectLocal: typeof inject;
|
|
|
429
443
|
//#endregion
|
|
430
444
|
//#region isDefined/index.d.ts
|
|
431
445
|
type IsDefinedReturn = boolean;
|
|
432
|
-
declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
|
|
433
|
-
declare function isDefined<T>(v: Ref<T>): v is Ref<Exclude<T, null | undefined>>;
|
|
434
|
-
declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
|
|
446
|
+
declare function isDefined<T$1>(v: ComputedRef<T$1>): v is ComputedRef<Exclude<T$1, null | undefined>>;
|
|
447
|
+
declare function isDefined<T$1>(v: Ref<T$1>): v is Ref<Exclude<T$1, null | undefined>>;
|
|
448
|
+
declare function isDefined<T$1>(v: T$1): v is Exclude<T$1, null | undefined>;
|
|
435
449
|
//#endregion
|
|
436
450
|
//#region makeDestructurable/index.d.ts
|
|
437
|
-
declare function makeDestructurable<T extends Record<string, unknown>, A extends readonly any[]>(obj: T, arr: A): T & A;
|
|
451
|
+
declare function makeDestructurable<T$1 extends Record<string, unknown>, A$1 extends readonly any[]>(obj: T$1, arr: A$1): T$1 & A$1;
|
|
438
452
|
//#endregion
|
|
439
453
|
//#region provideLocal/map.d.ts
|
|
440
|
-
type LocalProvidedKey<T> = InjectionKey<T> | string | number;
|
|
454
|
+
type LocalProvidedKey<T$1> = InjectionKey<T$1> | string | number;
|
|
441
455
|
//#endregion
|
|
442
456
|
//#region provideLocal/index.d.ts
|
|
443
457
|
type ProvideLocalReturn = void;
|
|
@@ -450,18 +464,18 @@ type ProvideLocalReturn = void;
|
|
|
450
464
|
* const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1
|
|
451
465
|
* ```
|
|
452
466
|
*/
|
|
453
|
-
declare function provideLocal<T, K = LocalProvidedKey<T>>(key: K, value: K extends InjectionKey<infer V> ? V : T): ProvideLocalReturn;
|
|
467
|
+
declare function provideLocal<T$1, K$1 = LocalProvidedKey<T$1>>(key: K$1, value: K$1 extends InjectionKey<infer V> ? V : T$1): ProvideLocalReturn;
|
|
454
468
|
//#endregion
|
|
455
469
|
//#region reactify/index.d.ts
|
|
456
|
-
type Reactified<T, Computed extends boolean> = T extends ((...args: infer A) => infer R) ? (...args: { [K in keyof A]: Computed extends true ? MaybeRefOrGetter<A[K]> : MaybeRef<A[K]> }) => ComputedRef<R> : never;
|
|
457
|
-
type ReactifyReturn<T extends AnyFn = AnyFn, K extends boolean = true> = Reactified<T, K>;
|
|
458
|
-
interface ReactifyOptions<T extends boolean> {
|
|
470
|
+
type Reactified<T$1, Computed extends boolean> = T$1 extends ((...args: infer A) => infer R) ? (...args: { [K in keyof A]: Computed extends true ? MaybeRefOrGetter<A[K]> : MaybeRef<A[K]> }) => ComputedRef<R> : never;
|
|
471
|
+
type ReactifyReturn<T$1 extends AnyFn = AnyFn, K$1 extends boolean = true> = Reactified<T$1, K$1>;
|
|
472
|
+
interface ReactifyOptions<T$1 extends boolean> {
|
|
459
473
|
/**
|
|
460
474
|
* Accept passing a function as a reactive getter
|
|
461
475
|
*
|
|
462
476
|
* @default true
|
|
463
477
|
*/
|
|
464
|
-
computedGetter?: T;
|
|
478
|
+
computedGetter?: T$1;
|
|
465
479
|
}
|
|
466
480
|
/**
|
|
467
481
|
* Converts plain function into a reactive function.
|
|
@@ -473,14 +487,14 @@ interface ReactifyOptions<T extends boolean> {
|
|
|
473
487
|
*
|
|
474
488
|
* @__NO_SIDE_EFFECTS__
|
|
475
489
|
*/
|
|
476
|
-
declare function reactify<T extends AnyFn, K extends boolean = true>(fn: T, options?: ReactifyOptions<K>): ReactifyReturn<T, K>;
|
|
490
|
+
declare function reactify<T$1 extends AnyFn, K$1 extends boolean = true>(fn: T$1, options?: ReactifyOptions<K$1>): ReactifyReturn<T$1, K$1>;
|
|
477
491
|
/** @deprecated use `reactify` instead */
|
|
478
492
|
declare const createReactiveFn: typeof reactify;
|
|
479
493
|
//#endregion
|
|
480
494
|
//#region reactifyObject/index.d.ts
|
|
481
|
-
type ReactifyNested<T, Keys extends keyof T = keyof T, S extends boolean = true> = { [K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S> : T[K] };
|
|
482
|
-
type ReactifyObjectReturn<T, Keys extends keyof T, S extends boolean = true> = ReactifyNested<T, Keys, S>;
|
|
483
|
-
interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
|
|
495
|
+
type ReactifyNested<T$1, Keys extends keyof T$1 = keyof T$1, S$1 extends boolean = true> = { [K in Keys]: T$1[K] extends AnyFn ? Reactified<T$1[K], S$1> : T$1[K] };
|
|
496
|
+
type ReactifyObjectReturn<T$1, Keys extends keyof T$1, S$1 extends boolean = true> = ReactifyNested<T$1, Keys, S$1>;
|
|
497
|
+
interface ReactifyObjectOptions<T$1 extends boolean> extends ReactifyOptions<T$1> {
|
|
484
498
|
/**
|
|
485
499
|
* Includes names from Object.getOwnPropertyNames
|
|
486
500
|
*
|
|
@@ -493,30 +507,30 @@ interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
|
|
|
493
507
|
*
|
|
494
508
|
* @__NO_SIDE_EFFECTS__
|
|
495
509
|
*/
|
|
496
|
-
declare function reactifyObject<T extends object, Keys extends keyof T>(obj: T, keys?: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>;
|
|
497
|
-
declare function reactifyObject<T extends object, S extends boolean = true>(obj: T, options?: ReactifyObjectOptions<S>): ReactifyObjectReturn<T, keyof T, S>;
|
|
510
|
+
declare function reactifyObject<T$1 extends object, Keys extends keyof T$1>(obj: T$1, keys?: (keyof T$1)[]): ReactifyObjectReturn<T$1, Keys, true>;
|
|
511
|
+
declare function reactifyObject<T$1 extends object, S$1 extends boolean = true>(obj: T$1, options?: ReactifyObjectOptions<S$1>): ReactifyObjectReturn<T$1, keyof T$1, S$1>;
|
|
498
512
|
//#endregion
|
|
499
513
|
//#region reactiveComputed/index.d.ts
|
|
500
|
-
type ReactiveComputedReturn<T extends object> = UnwrapNestedRefs<T>;
|
|
514
|
+
type ReactiveComputedReturn<T$1 extends object> = UnwrapNestedRefs<T$1>;
|
|
501
515
|
/**
|
|
502
516
|
* Computed reactive object.
|
|
503
517
|
*/
|
|
504
|
-
declare function reactiveComputed<T extends object>(fn: ComputedGetter<T>): ReactiveComputedReturn<T>;
|
|
518
|
+
declare function reactiveComputed<T$1 extends object>(fn: ComputedGetter<T$1>): ReactiveComputedReturn<T$1>;
|
|
505
519
|
//#endregion
|
|
506
520
|
//#region reactiveOmit/index.d.ts
|
|
507
|
-
type ReactiveOmitReturn<T extends object, K extends keyof T | undefined = undefined> = [K] extends [undefined] ? Partial<T> : Omit<T, Extract<K, keyof T>>;
|
|
508
|
-
type ReactiveOmitPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
509
|
-
declare function reactiveOmit<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): ReactiveOmitReturn<T, K>;
|
|
510
|
-
declare function reactiveOmit<T extends object>(obj: T, predicate: ReactiveOmitPredicate<T>): ReactiveOmitReturn<T>;
|
|
521
|
+
type ReactiveOmitReturn<T$1 extends object, K$1 extends keyof T$1 | undefined = undefined> = [K$1] extends [undefined] ? Partial<T$1> : Omit<T$1, Extract<K$1, keyof T$1>>;
|
|
522
|
+
type ReactiveOmitPredicate<T$1> = (value: T$1[keyof T$1], key: keyof T$1) => boolean;
|
|
523
|
+
declare function reactiveOmit<T$1 extends object, K$1 extends keyof T$1>(obj: T$1, ...keys: (K$1 | K$1[])[]): ReactiveOmitReturn<T$1, K$1>;
|
|
524
|
+
declare function reactiveOmit<T$1 extends object>(obj: T$1, predicate: ReactiveOmitPredicate<T$1>): ReactiveOmitReturn<T$1>;
|
|
511
525
|
//#endregion
|
|
512
526
|
//#region reactivePick/index.d.ts
|
|
513
|
-
type ReactivePickReturn<T extends object, K extends keyof T> = { [S in K]: UnwrapRef<T[S]> };
|
|
514
|
-
type ReactivePickPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
515
|
-
declare function reactivePick<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): ReactivePickReturn<T, K>;
|
|
516
|
-
declare function reactivePick<T extends object>(obj: T, predicate: ReactivePickPredicate<T>): ReactivePickReturn<T, keyof T>;
|
|
527
|
+
type ReactivePickReturn<T$1 extends object, K$1 extends keyof T$1> = { [S in K$1]: UnwrapRef<T$1[S]> };
|
|
528
|
+
type ReactivePickPredicate<T$1> = (value: T$1[keyof T$1], key: keyof T$1) => boolean;
|
|
529
|
+
declare function reactivePick<T$1 extends object, K$1 extends keyof T$1>(obj: T$1, ...keys: (K$1 | K$1[])[]): ReactivePickReturn<T$1, K$1>;
|
|
530
|
+
declare function reactivePick<T$1 extends object>(obj: T$1, predicate: ReactivePickPredicate<T$1>): ReactivePickReturn<T$1, keyof T$1>;
|
|
517
531
|
//#endregion
|
|
518
532
|
//#region refAutoReset/index.d.ts
|
|
519
|
-
type RefAutoResetReturn<T = any> = Ref<T>;
|
|
533
|
+
type RefAutoResetReturn<T$1 = any> = Ref<T$1>;
|
|
520
534
|
/**
|
|
521
535
|
* Create a ref which will be reset to the default value after some time.
|
|
522
536
|
*
|
|
@@ -524,18 +538,18 @@ type RefAutoResetReturn<T = any> = Ref<T>;
|
|
|
524
538
|
* @param defaultValue The value which will be set.
|
|
525
539
|
* @param afterMs A zero-or-greater delay in milliseconds.
|
|
526
540
|
*/
|
|
527
|
-
declare function refAutoReset<T>(defaultValue: MaybeRefOrGetter<T>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T>;
|
|
541
|
+
declare function refAutoReset<T$1>(defaultValue: MaybeRefOrGetter<T$1>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T$1>;
|
|
528
542
|
/** @deprecated use `refAutoReset` instead */
|
|
529
543
|
declare const autoResetRef: typeof refAutoReset;
|
|
530
544
|
//#endregion
|
|
531
545
|
//#region refDebounced/index.d.ts
|
|
532
|
-
type RefDebouncedReturn<T = any> = Readonly<Ref<T>>;
|
|
546
|
+
type RefDebouncedReturn<T$1 = any> = Readonly<Ref<T$1>>;
|
|
533
547
|
/**
|
|
534
548
|
* Debounce updates of a ref.
|
|
535
549
|
*
|
|
536
550
|
* @return A new debounced ref.
|
|
537
551
|
*/
|
|
538
|
-
declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T>;
|
|
552
|
+
declare function refDebounced<T$1>(value: Ref<T$1>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T$1>;
|
|
539
553
|
/** @deprecated use `refDebounced` instead */
|
|
540
554
|
declare const debouncedRef: typeof refDebounced;
|
|
541
555
|
/** @deprecated use `refDebounced` instead */
|
|
@@ -547,7 +561,7 @@ declare const useDebounce: typeof refDebounced;
|
|
|
547
561
|
*
|
|
548
562
|
* @__NO_SIDE_EFFECTS__
|
|
549
563
|
*/
|
|
550
|
-
declare function refDefault<T>(source: Ref<T | undefined | null>, defaultValue: T): Ref<T>;
|
|
564
|
+
declare function refDefault<T$1>(source: Ref<T$1 | undefined | null>, defaultValue: T$1): Ref<T$1>;
|
|
551
565
|
//#endregion
|
|
552
566
|
//#region refManualReset/index.d.ts
|
|
553
567
|
/**
|
|
@@ -556,8 +570,8 @@ declare function refDefault<T>(source: Ref<T | undefined | null>, defaultValue:
|
|
|
556
570
|
* This interface extends the standard `Ref` type from Vue and adds a `reset` method.
|
|
557
571
|
* The `reset` method allows the ref to be manually reset to its default value.
|
|
558
572
|
*/
|
|
559
|
-
interface ManualResetRefReturn<T> extends Ref<T> {
|
|
560
|
-
reset: Fn
|
|
573
|
+
interface ManualResetRefReturn<T$1> extends Ref<T$1> {
|
|
574
|
+
reset: Fn;
|
|
561
575
|
}
|
|
562
576
|
/**
|
|
563
577
|
* Create a ref with manual reset functionality.
|
|
@@ -565,10 +579,10 @@ interface ManualResetRefReturn<T> extends Ref<T> {
|
|
|
565
579
|
* @see https://vueuse.org/refManualReset
|
|
566
580
|
* @param defaultValue The value which will be set.
|
|
567
581
|
*/
|
|
568
|
-
declare function refManualReset<T>(defaultValue: MaybeRefOrGetter<T>): ManualResetRefReturn<T>;
|
|
582
|
+
declare function refManualReset<T$1>(defaultValue: MaybeRefOrGetter<T$1>): ManualResetRefReturn<T$1>;
|
|
569
583
|
//#endregion
|
|
570
584
|
//#region refThrottled/index.d.ts
|
|
571
|
-
type RefThrottledReturn<T = any> = Ref<T>;
|
|
585
|
+
type RefThrottledReturn<T$1 = any> = Ref<T$1>;
|
|
572
586
|
/**
|
|
573
587
|
* Throttle execution of a function. Especially useful for rate limiting
|
|
574
588
|
* execution of handlers on events like resize and scroll.
|
|
@@ -578,89 +592,89 @@ type RefThrottledReturn<T = any> = Ref<T>;
|
|
|
578
592
|
* @param trailing if true, update the value again after the delay time is up
|
|
579
593
|
* @param leading if true, update the value on the leading edge of the ms timeout
|
|
580
594
|
*/
|
|
581
|
-
declare function refThrottled<T = any>(value: Ref<T>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T>;
|
|
595
|
+
declare function refThrottled<T$1 = any>(value: Ref<T$1>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T$1>;
|
|
582
596
|
/** @deprecated use `refThrottled` instead */
|
|
583
597
|
declare const throttledRef: typeof refThrottled;
|
|
584
598
|
/** @deprecated use `refThrottled` instead */
|
|
585
599
|
declare const useThrottle: typeof refThrottled;
|
|
586
600
|
//#endregion
|
|
587
601
|
//#region refWithControl/index.d.ts
|
|
588
|
-
interface ControlledRefOptions<T> {
|
|
602
|
+
interface ControlledRefOptions<T$1> {
|
|
589
603
|
/**
|
|
590
604
|
* Callback function before the ref changing.
|
|
591
605
|
*
|
|
592
606
|
* Returning `false` to dismiss the change.
|
|
593
607
|
*/
|
|
594
|
-
onBeforeChange?: (value: T, oldValue: T) => void | boolean;
|
|
608
|
+
onBeforeChange?: (value: T$1, oldValue: T$1) => void | boolean;
|
|
595
609
|
/**
|
|
596
610
|
* Callback function after the ref changed
|
|
597
611
|
*
|
|
598
612
|
* This happens synchronously, with less overhead compare to `watch`
|
|
599
613
|
*/
|
|
600
|
-
onChanged?: (value: T, oldValue: T) => void;
|
|
614
|
+
onChanged?: (value: T$1, oldValue: T$1) => void;
|
|
601
615
|
}
|
|
602
616
|
/**
|
|
603
617
|
* Fine-grained controls over ref and its reactivity.
|
|
604
618
|
*
|
|
605
619
|
* @__NO_SIDE_EFFECTS__
|
|
606
620
|
*/
|
|
607
|
-
declare function refWithControl<T>(initial: T, options?: ControlledRefOptions<T>): vue0.ShallowUnwrapRef<{
|
|
608
|
-
get: (tracking?: boolean) => T;
|
|
609
|
-
set: (value: T, triggering?: boolean) => void;
|
|
610
|
-
untrackedGet: () => T;
|
|
611
|
-
silentSet: (v: T) => void;
|
|
612
|
-
peek: () => T;
|
|
613
|
-
lay: (v: T) => void;
|
|
614
|
-
}> & vue0.Ref<T, T>;
|
|
621
|
+
declare function refWithControl<T$1>(initial: T$1, options?: ControlledRefOptions<T$1>): vue0.ShallowUnwrapRef<{
|
|
622
|
+
get: (tracking?: boolean) => T$1;
|
|
623
|
+
set: (value: T$1, triggering?: boolean) => void;
|
|
624
|
+
untrackedGet: () => T$1;
|
|
625
|
+
silentSet: (v: T$1) => void;
|
|
626
|
+
peek: () => T$1;
|
|
627
|
+
lay: (v: T$1) => void;
|
|
628
|
+
}> & vue0.Ref<T$1, T$1>;
|
|
615
629
|
/** @deprecated use `refWithControl` instead */
|
|
616
630
|
declare const controlledRef: typeof refWithControl;
|
|
617
631
|
//#endregion
|
|
618
632
|
//#region set/index.d.ts
|
|
619
|
-
declare function set<T>(ref: Ref<T>, value: T): void;
|
|
620
|
-
declare function set<O extends object, K extends keyof O>(target: O, key: K, value: O[K]): void;
|
|
633
|
+
declare function set<T$1>(ref: Ref<T$1>, value: T$1): void;
|
|
634
|
+
declare function set<O extends object, K$1 extends keyof O>(target: O, key: K$1, value: O[K$1]): void;
|
|
621
635
|
//#endregion
|
|
622
636
|
//#region syncRef/index.d.ts
|
|
623
637
|
type Direction = 'ltr' | 'rtl' | 'both';
|
|
624
|
-
type SpecificFieldPartial<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
|
|
638
|
+
type SpecificFieldPartial<T$1, K$1 extends keyof T$1> = Partial<Pick<T$1, K$1>> & Omit<T$1, K$1>;
|
|
625
639
|
/**
|
|
626
640
|
* A = B
|
|
627
641
|
*/
|
|
628
|
-
type Equal<A, B> = [A] extends [B] ? ([B] extends [A] ? true : false) : false;
|
|
642
|
+
type Equal<A$1, B> = [A$1] extends [B] ? ([B] extends [A$1] ? true : false) : false;
|
|
629
643
|
/**
|
|
630
644
|
* A ∩ B ≠ ∅
|
|
631
645
|
*/
|
|
632
|
-
type IntersectButNotEqual<A, B> = Equal<A, B> extends true ? false : A & B extends never ? false : true;
|
|
646
|
+
type IntersectButNotEqual<A$1, B> = Equal<A$1, B> extends true ? false : A$1 & B extends never ? false : true;
|
|
633
647
|
/**
|
|
634
648
|
* A ⊆ B
|
|
635
649
|
*/
|
|
636
|
-
type IncludeButNotEqual<A, B> = Equal<A, B> extends true ? false : A extends B ? true : false;
|
|
650
|
+
type IncludeButNotEqual<A$1, B> = Equal<A$1, B> extends true ? false : A$1 extends B ? true : false;
|
|
637
651
|
/**
|
|
638
652
|
* A ∩ B = ∅
|
|
639
653
|
*/
|
|
640
|
-
type NotIntersect<A, B> = Equal<A, B> extends true ? false : A & B extends never ? true : false;
|
|
641
|
-
interface EqualType<D extends Direction, L, R, O extends keyof Transform<L, R> = (D extends 'both' ? 'ltr' | 'rtl' : D)> {
|
|
642
|
-
transform?: SpecificFieldPartial<Pick<Transform<L, R>, O>, O>;
|
|
654
|
+
type NotIntersect<A$1, B> = Equal<A$1, B> extends true ? false : A$1 & B extends never ? true : false;
|
|
655
|
+
interface EqualType<D extends Direction, L, R$1, O extends keyof Transform<L, R$1> = (D extends 'both' ? 'ltr' | 'rtl' : D)> {
|
|
656
|
+
transform?: SpecificFieldPartial<Pick<Transform<L, R$1>, O>, O>;
|
|
643
657
|
}
|
|
644
|
-
type StrictIncludeMap<IncludeType extends 'LR' | 'RL', D extends Exclude<Direction, 'both'>, L, R> = (Equal<[IncludeType, D], ['LR', 'ltr']> & Equal<[IncludeType, D], ['RL', 'rtl']>) extends true ? {
|
|
645
|
-
transform?: SpecificFieldPartial<Pick<Transform<L, R>, D>, D>;
|
|
658
|
+
type StrictIncludeMap<IncludeType extends 'LR' | 'RL', D extends Exclude<Direction, 'both'>, L, R$1> = (Equal<[IncludeType, D], ['LR', 'ltr']> & Equal<[IncludeType, D], ['RL', 'rtl']>) extends true ? {
|
|
659
|
+
transform?: SpecificFieldPartial<Pick<Transform<L, R$1>, D>, D>;
|
|
646
660
|
} : {
|
|
647
|
-
transform: Pick<Transform<L, R>, D>;
|
|
661
|
+
transform: Pick<Transform<L, R$1>, D>;
|
|
648
662
|
};
|
|
649
|
-
type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direction, L, R> = D extends 'both' ? {
|
|
650
|
-
transform: SpecificFieldPartial<Transform<L, R>, IncludeType extends 'LR' ? 'ltr' : 'rtl'>;
|
|
651
|
-
} : D extends Exclude<Direction, 'both'> ? StrictIncludeMap<IncludeType, D, L, R> : never;
|
|
652
|
-
type IntersectButNotEqualType<D extends Direction, L, R> = D extends 'both' ? {
|
|
653
|
-
transform: Transform<L, R>;
|
|
663
|
+
type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direction, L, R$1> = D extends 'both' ? {
|
|
664
|
+
transform: SpecificFieldPartial<Transform<L, R$1>, IncludeType extends 'LR' ? 'ltr' : 'rtl'>;
|
|
665
|
+
} : D extends Exclude<Direction, 'both'> ? StrictIncludeMap<IncludeType, D, L, R$1> : never;
|
|
666
|
+
type IntersectButNotEqualType<D extends Direction, L, R$1> = D extends 'both' ? {
|
|
667
|
+
transform: Transform<L, R$1>;
|
|
654
668
|
} : D extends Exclude<Direction, 'both'> ? {
|
|
655
|
-
transform: Pick<Transform<L, R>, D>;
|
|
669
|
+
transform: Pick<Transform<L, R$1>, D>;
|
|
656
670
|
} : never;
|
|
657
|
-
type NotIntersectType<D extends Direction, L, R> = IntersectButNotEqualType<D, L, R>;
|
|
658
|
-
interface Transform<L, R> {
|
|
659
|
-
ltr: (left: L) => R;
|
|
660
|
-
rtl: (right: R) => L;
|
|
671
|
+
type NotIntersectType<D extends Direction, L, R$1> = IntersectButNotEqualType<D, L, R$1>;
|
|
672
|
+
interface Transform<L, R$1> {
|
|
673
|
+
ltr: (left: L) => R$1;
|
|
674
|
+
rtl: (right: R$1) => L;
|
|
661
675
|
}
|
|
662
|
-
type TransformType<D extends Direction, L, R> = Equal<L, R> extends true ? EqualType<D, L, R> : IncludeButNotEqual<L, R> extends true ? StrictIncludeType<'LR', D, L, R> : IncludeButNotEqual<R, L> extends true ? StrictIncludeType<'RL', D, L, R> : IntersectButNotEqual<L, R> extends true ? IntersectButNotEqualType<D, L, R> : NotIntersect<L, R> extends true ? NotIntersectType<D, L, R> : never;
|
|
663
|
-
type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlushSync & {
|
|
676
|
+
type TransformType<D extends Direction, L, R$1> = Equal<L, R$1> extends true ? EqualType<D, L, R$1> : IncludeButNotEqual<L, R$1> extends true ? StrictIncludeType<'LR', D, L, R$1> : IncludeButNotEqual<R$1, L> extends true ? StrictIncludeType<'RL', D, L, R$1> : IntersectButNotEqual<L, R$1> extends true ? IntersectButNotEqualType<D, L, R$1> : NotIntersect<L, R$1> extends true ? NotIntersectType<D, L, R$1> : never;
|
|
677
|
+
type SyncRefOptions<L, R$1, D extends Direction> = ConfigurableFlushSync & {
|
|
664
678
|
/**
|
|
665
679
|
* Watch deeply
|
|
666
680
|
*
|
|
@@ -679,7 +693,7 @@ type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlushSync & {
|
|
|
679
693
|
* @default 'both'
|
|
680
694
|
*/
|
|
681
695
|
direction?: D;
|
|
682
|
-
} & TransformType<D, L, R>;
|
|
696
|
+
} & TransformType<D, L, R$1>;
|
|
683
697
|
/**
|
|
684
698
|
* Two-way refs synchronization.
|
|
685
699
|
* From the set theory perspective to restrict the option's type
|
|
@@ -689,7 +703,7 @@ type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlushSync & {
|
|
|
689
703
|
* 3. L ⊆ R
|
|
690
704
|
* 4. L ∩ R = ∅
|
|
691
705
|
*/
|
|
692
|
-
declare function syncRef<L, R, D extends Direction = 'both'>(left: Ref<L>, right: Ref<R>, ...[options]: Equal<L, R> extends true ? [options?: SyncRefOptions<L, R, D>] : [options: SyncRefOptions<L, R, D>]): () => void;
|
|
706
|
+
declare function syncRef<L, R$1, D extends Direction = 'both'>(left: Ref<L>, right: Ref<R$1>, ...[options]: Equal<L, R$1> extends true ? [options?: SyncRefOptions<L, R$1, D>] : [options: SyncRefOptions<L, R$1, D>]): () => void;
|
|
693
707
|
//#endregion
|
|
694
708
|
//#region syncRefs/index.d.ts
|
|
695
709
|
interface SyncRefsOptions extends ConfigurableFlushSync {
|
|
@@ -712,7 +726,7 @@ interface SyncRefsOptions extends ConfigurableFlushSync {
|
|
|
712
726
|
* @param source source ref
|
|
713
727
|
* @param targets
|
|
714
728
|
*/
|
|
715
|
-
declare function syncRefs<T>(source: WatchSource<T>, targets: Ref<T> | Ref<T>[], options?: SyncRefsOptions): vue0.WatchHandle;
|
|
729
|
+
declare function syncRefs<T$1>(source: WatchSource<T$1>, targets: Ref<T$1> | Ref<T$1>[], options?: SyncRefsOptions): vue0.WatchHandle;
|
|
716
730
|
//#endregion
|
|
717
731
|
//#region toReactive/index.d.ts
|
|
718
732
|
/**
|
|
@@ -721,18 +735,18 @@ declare function syncRefs<T>(source: WatchSource<T>, targets: Ref<T> | Ref<T>[],
|
|
|
721
735
|
* @see https://vueuse.org/toReactive
|
|
722
736
|
* @param objectRef A ref of object
|
|
723
737
|
*/
|
|
724
|
-
declare function toReactive<T extends object>(objectRef: MaybeRef<T>): UnwrapNestedRefs<T>;
|
|
738
|
+
declare function toReactive<T$1 extends object>(objectRef: MaybeRef<T$1>): UnwrapNestedRefs<T$1>;
|
|
725
739
|
//#endregion
|
|
726
740
|
//#region toRef/index.d.ts
|
|
727
741
|
/**
|
|
728
742
|
* Normalize value/ref/getter to `ref` or `computed`.
|
|
729
743
|
*/
|
|
730
|
-
declare function toRef<T>(r: () => T): Readonly<Ref<T>>;
|
|
731
|
-
declare function toRef<T>(r: ComputedRef<T>): ComputedRef<T>;
|
|
732
|
-
declare function toRef<T>(r: MaybeRefOrGetter<T>): Ref<T>;
|
|
733
|
-
declare function toRef<T>(r: T): Ref<T>;
|
|
734
|
-
declare function toRef<T extends object, K extends keyof T>(object: T, key: K): ToRef<T[K]>;
|
|
735
|
-
declare function toRef<T extends object, K extends keyof T>(object: T, key: K, defaultValue: T[K]): ToRef<Exclude<T[K], undefined>>;
|
|
744
|
+
declare function toRef<T$1>(r: () => T$1): Readonly<Ref<T$1>>;
|
|
745
|
+
declare function toRef<T$1>(r: ComputedRef<T$1>): ComputedRef<T$1>;
|
|
746
|
+
declare function toRef<T$1>(r: MaybeRefOrGetter<T$1>): Ref<T$1>;
|
|
747
|
+
declare function toRef<T$1>(r: T$1): Ref<T$1>;
|
|
748
|
+
declare function toRef<T$1 extends object, K$1 extends keyof T$1>(object: T$1, key: K$1): ToRef<T$1[K$1]>;
|
|
749
|
+
declare function toRef<T$1 extends object, K$1 extends keyof T$1>(object: T$1, key: K$1, defaultValue: T$1[K$1]): ToRef<Exclude<T$1[K$1], undefined>>;
|
|
736
750
|
//#endregion
|
|
737
751
|
//#region toRefs/index.d.ts
|
|
738
752
|
interface ToRefsOptions {
|
|
@@ -750,7 +764,7 @@ interface ToRefsOptions {
|
|
|
750
764
|
* @param objectRef A ref or normal object or array.
|
|
751
765
|
* @param options Options
|
|
752
766
|
*/
|
|
753
|
-
declare function toRefs<T extends object>(objectRef: MaybeRef<T>, options?: ToRefsOptions): ToRefs<T>;
|
|
767
|
+
declare function toRefs<T$1 extends object>(objectRef: MaybeRef<T$1>, options?: ToRefsOptions): ToRefs<T$1>;
|
|
754
768
|
//#endregion
|
|
755
769
|
//#region tryOnBeforeMount/index.d.ts
|
|
756
770
|
/**
|
|
@@ -760,7 +774,7 @@ declare function toRefs<T extends object>(objectRef: MaybeRef<T>, options?: ToRe
|
|
|
760
774
|
* @param sync if set to false, it will run in the nextTick() of Vue
|
|
761
775
|
* @param target
|
|
762
776
|
*/
|
|
763
|
-
declare function tryOnBeforeMount(fn: Fn
|
|
777
|
+
declare function tryOnBeforeMount(fn: Fn, sync?: boolean, target?: ComponentInternalInstance | null): void;
|
|
764
778
|
//#endregion
|
|
765
779
|
//#region tryOnBeforeUnmount/index.d.ts
|
|
766
780
|
/**
|
|
@@ -769,7 +783,7 @@ declare function tryOnBeforeMount(fn: Fn$1, sync?: boolean, target?: any): void;
|
|
|
769
783
|
* @param fn
|
|
770
784
|
* @param target
|
|
771
785
|
*/
|
|
772
|
-
declare function tryOnBeforeUnmount(fn: Fn
|
|
786
|
+
declare function tryOnBeforeUnmount(fn: Fn, target?: ComponentInternalInstance | null): void;
|
|
773
787
|
//#endregion
|
|
774
788
|
//#region tryOnMounted/index.d.ts
|
|
775
789
|
/**
|
|
@@ -779,7 +793,7 @@ declare function tryOnBeforeUnmount(fn: Fn$1, target?: any): void;
|
|
|
779
793
|
* @param sync if set to false, it will run in the nextTick() of Vue
|
|
780
794
|
* @param target
|
|
781
795
|
*/
|
|
782
|
-
declare function tryOnMounted(fn: Fn
|
|
796
|
+
declare function tryOnMounted(fn: Fn, sync?: boolean, target?: ComponentInternalInstance | null): void;
|
|
783
797
|
//#endregion
|
|
784
798
|
//#region tryOnScopeDispose/index.d.ts
|
|
785
799
|
/**
|
|
@@ -787,7 +801,7 @@ declare function tryOnMounted(fn: Fn$1, sync?: boolean, target?: any): void;
|
|
|
787
801
|
*
|
|
788
802
|
* @param fn
|
|
789
803
|
*/
|
|
790
|
-
declare function tryOnScopeDispose(fn: Fn
|
|
804
|
+
declare function tryOnScopeDispose(fn: Fn, failSilently?: boolean): boolean;
|
|
791
805
|
//#endregion
|
|
792
806
|
//#region tryOnUnmounted/index.d.ts
|
|
793
807
|
/**
|
|
@@ -796,7 +810,7 @@ declare function tryOnScopeDispose(fn: Fn$1): boolean;
|
|
|
796
810
|
* @param fn
|
|
797
811
|
* @param target
|
|
798
812
|
*/
|
|
799
|
-
declare function tryOnUnmounted(fn: Fn
|
|
813
|
+
declare function tryOnUnmounted(fn: Fn, target?: ComponentInternalInstance | null): void;
|
|
800
814
|
//#endregion
|
|
801
815
|
//#region until/index.d.ts
|
|
802
816
|
interface UntilToMatchOptions {
|
|
@@ -826,23 +840,23 @@ interface UntilToMatchOptions {
|
|
|
826
840
|
*/
|
|
827
841
|
deep?: WatchOptions['deep'];
|
|
828
842
|
}
|
|
829
|
-
interface UntilBaseInstance<T, Not extends boolean = false> {
|
|
830
|
-
toMatch: (<U extends T = T>(condition: (v: T) => v is U, options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, U>> : Promise<U>) & ((condition: (v: T) => boolean, options?: UntilToMatchOptions) => Promise<T>);
|
|
831
|
-
changed: (options?: UntilToMatchOptions) => Promise<T>;
|
|
832
|
-
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T>;
|
|
843
|
+
interface UntilBaseInstance<T$1, Not extends boolean = false> {
|
|
844
|
+
toMatch: (<U extends T$1 = T$1>(condition: (v: T$1) => v is U, options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, U>> : Promise<U>) & ((condition: (v: T$1) => boolean, options?: UntilToMatchOptions) => Promise<T$1>);
|
|
845
|
+
changed: (options?: UntilToMatchOptions) => Promise<T$1>;
|
|
846
|
+
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T$1>;
|
|
833
847
|
}
|
|
834
|
-
type Falsy
|
|
835
|
-
interface UntilValueInstance<T, Not extends boolean = false> extends UntilBaseInstance<T, Not> {
|
|
836
|
-
readonly not: UntilValueInstance<T, Not extends true ? false : true>;
|
|
837
|
-
toBe: <P = T>(value: MaybeRefOrGetter<P>, options?: UntilToMatchOptions) => Not extends true ? Promise<T> : Promise<P>;
|
|
838
|
-
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T & Falsy
|
|
839
|
-
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, null>> : Promise<null>;
|
|
840
|
-
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, undefined>> : Promise<undefined>;
|
|
841
|
-
toBeNaN: (options?: UntilToMatchOptions) => Promise<T>;
|
|
848
|
+
type Falsy = false | void | null | undefined | 0 | 0n | '';
|
|
849
|
+
interface UntilValueInstance<T$1, Not extends boolean = false> extends UntilBaseInstance<T$1, Not> {
|
|
850
|
+
readonly not: UntilValueInstance<T$1, Not extends true ? false : true>;
|
|
851
|
+
toBe: <P = T$1>(value: MaybeRefOrGetter<P>, options?: UntilToMatchOptions) => Not extends true ? Promise<T$1> : Promise<P>;
|
|
852
|
+
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T$1 & Falsy> : Promise<Exclude<T$1, Falsy>>;
|
|
853
|
+
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, null>> : Promise<null>;
|
|
854
|
+
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, undefined>> : Promise<undefined>;
|
|
855
|
+
toBeNaN: (options?: UntilToMatchOptions) => Promise<T$1>;
|
|
842
856
|
}
|
|
843
|
-
interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
844
|
-
readonly not: UntilArrayInstance<T>;
|
|
845
|
-
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T>>>, options?: UntilToMatchOptions) => Promise<T>;
|
|
857
|
+
interface UntilArrayInstance<T$1> extends UntilBaseInstance<T$1> {
|
|
858
|
+
readonly not: UntilArrayInstance<T$1>;
|
|
859
|
+
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T$1>>>, options?: UntilToMatchOptions) => Promise<T$1>;
|
|
846
860
|
}
|
|
847
861
|
/**
|
|
848
862
|
* Promised one-time watch for changes
|
|
@@ -857,8 +871,8 @@ interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
|
857
871
|
* alert('Counter is now larger than 7!')
|
|
858
872
|
* ```
|
|
859
873
|
*/
|
|
860
|
-
declare function until<T extends unknown[]>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilArrayInstance<T>;
|
|
861
|
-
declare function until<T>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilValueInstance<T>;
|
|
874
|
+
declare function until<T$1 extends unknown[]>(r: WatchSource<T$1> | MaybeRefOrGetter<T$1>): UntilArrayInstance<T$1>;
|
|
875
|
+
declare function until<T$1>(r: WatchSource<T$1> | MaybeRefOrGetter<T$1>): UntilValueInstance<T$1>;
|
|
862
876
|
//#endregion
|
|
863
877
|
//#region useArrayDifference/index.d.ts
|
|
864
878
|
interface UseArrayDifferenceOptions {
|
|
@@ -870,9 +884,9 @@ interface UseArrayDifferenceOptions {
|
|
|
870
884
|
*/
|
|
871
885
|
symmetric?: boolean;
|
|
872
886
|
}
|
|
873
|
-
type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;
|
|
874
|
-
declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, key?: keyof T, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
875
|
-
declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, compareFn?: (value: T, othVal: T) => boolean, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
887
|
+
type UseArrayDifferenceReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
888
|
+
declare function useArrayDifference<T$1>(list: MaybeRefOrGetter<T$1[]>, values: MaybeRefOrGetter<T$1[]>, key?: keyof T$1, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T$1>;
|
|
889
|
+
declare function useArrayDifference<T$1>(list: MaybeRefOrGetter<T$1[]>, values: MaybeRefOrGetter<T$1[]>, compareFn?: (value: T$1, othVal: T$1) => boolean, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T$1>;
|
|
876
890
|
//#endregion
|
|
877
891
|
//#region useArrayEvery/index.d.ts
|
|
878
892
|
type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
@@ -887,10 +901,10 @@ type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
|
887
901
|
*
|
|
888
902
|
* @__NO_SIDE_EFFECTS__
|
|
889
903
|
*/
|
|
890
|
-
declare function useArrayEvery<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayEveryReturn;
|
|
904
|
+
declare function useArrayEvery<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArrayEveryReturn;
|
|
891
905
|
//#endregion
|
|
892
906
|
//#region useArrayFilter/index.d.ts
|
|
893
|
-
type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
907
|
+
type UseArrayFilterReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
894
908
|
/**
|
|
895
909
|
* Reactive `Array.filter`
|
|
896
910
|
*
|
|
@@ -902,11 +916,11 @@ type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
|
902
916
|
*
|
|
903
917
|
* @__NO_SIDE_EFFECTS__
|
|
904
918
|
*/
|
|
905
|
-
declare function useArrayFilter<T, S extends T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => element is S): UseArrayFilterReturn<S>;
|
|
906
|
-
declare function useArrayFilter<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => unknown): UseArrayFilterReturn<T>;
|
|
919
|
+
declare function useArrayFilter<T$1, S$1 extends T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => element is S$1): UseArrayFilterReturn<S$1>;
|
|
920
|
+
declare function useArrayFilter<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => unknown): UseArrayFilterReturn<T$1>;
|
|
907
921
|
//#endregion
|
|
908
922
|
//#region useArrayFind/index.d.ts
|
|
909
|
-
type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
923
|
+
type UseArrayFindReturn<T$1 = any> = ComputedRef<T$1 | undefined>;
|
|
910
924
|
/**
|
|
911
925
|
* Reactive `Array.find`
|
|
912
926
|
*
|
|
@@ -918,7 +932,7 @@ type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
|
918
932
|
*
|
|
919
933
|
* @__NO_SIDE_EFFECTS__
|
|
920
934
|
*/
|
|
921
|
-
declare function useArrayFind<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindReturn<T>;
|
|
935
|
+
declare function useArrayFind<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean): UseArrayFindReturn<T$1>;
|
|
922
936
|
//#endregion
|
|
923
937
|
//#region useArrayFindIndex/index.d.ts
|
|
924
938
|
type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
@@ -933,10 +947,10 @@ type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
|
933
947
|
*
|
|
934
948
|
* @__NO_SIDE_EFFECTS__
|
|
935
949
|
*/
|
|
936
|
-
declare function useArrayFindIndex<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayFindIndexReturn;
|
|
950
|
+
declare function useArrayFindIndex<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArrayFindIndexReturn;
|
|
937
951
|
//#endregion
|
|
938
952
|
//#region useArrayFindLast/index.d.ts
|
|
939
|
-
type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
953
|
+
type UseArrayFindLastReturn<T$1 = any> = ComputedRef<T$1 | undefined>;
|
|
940
954
|
/**
|
|
941
955
|
* Reactive `Array.findLast`
|
|
942
956
|
*
|
|
@@ -948,13 +962,13 @@ type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
|
948
962
|
*
|
|
949
963
|
* @__NO_SIDE_EFFECTS__
|
|
950
964
|
*/
|
|
951
|
-
declare function useArrayFindLast<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindLastReturn<T>;
|
|
965
|
+
declare function useArrayFindLast<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean): UseArrayFindLastReturn<T$1>;
|
|
952
966
|
//#endregion
|
|
953
967
|
//#region useArrayIncludes/index.d.ts
|
|
954
|
-
type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeRefOrGetter<T>[]) => boolean);
|
|
955
|
-
interface UseArrayIncludesOptions<T, V> {
|
|
968
|
+
type UseArrayIncludesComparatorFn<T$1, V$1> = ((element: T$1, value: V$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean);
|
|
969
|
+
interface UseArrayIncludesOptions<T$1, V$1> {
|
|
956
970
|
fromIndex?: number;
|
|
957
|
-
comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T;
|
|
971
|
+
comparator?: UseArrayIncludesComparatorFn<T$1, V$1> | keyof T$1;
|
|
958
972
|
}
|
|
959
973
|
type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
960
974
|
/**
|
|
@@ -966,9 +980,9 @@ type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
|
966
980
|
*
|
|
967
981
|
* @__NO_SIDE_EFFECTS__
|
|
968
982
|
*/
|
|
969
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, comparator?: UseArrayIncludesComparatorFn<T, V>): UseArrayIncludesReturn;
|
|
970
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, comparator?: keyof T): UseArrayIncludesReturn;
|
|
971
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, options?: UseArrayIncludesOptions<T, V>): UseArrayIncludesReturn;
|
|
983
|
+
declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, comparator?: UseArrayIncludesComparatorFn<T$1, V$1>): UseArrayIncludesReturn;
|
|
984
|
+
declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, comparator?: keyof T$1): UseArrayIncludesReturn;
|
|
985
|
+
declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, options?: UseArrayIncludesOptions<T$1, V$1>): UseArrayIncludesReturn;
|
|
972
986
|
//#endregion
|
|
973
987
|
//#region useArrayJoin/index.d.ts
|
|
974
988
|
type UseArrayJoinReturn = ComputedRef<string>;
|
|
@@ -986,7 +1000,7 @@ type UseArrayJoinReturn = ComputedRef<string>;
|
|
|
986
1000
|
declare function useArrayJoin(list: MaybeRefOrGetter<MaybeRefOrGetter<any>[]>, separator?: MaybeRefOrGetter<string>): UseArrayJoinReturn;
|
|
987
1001
|
//#endregion
|
|
988
1002
|
//#region useArrayMap/index.d.ts
|
|
989
|
-
type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
1003
|
+
type UseArrayMapReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
990
1004
|
/**
|
|
991
1005
|
* Reactive `Array.map`
|
|
992
1006
|
*
|
|
@@ -998,10 +1012,10 @@ type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
|
998
1012
|
*
|
|
999
1013
|
* @__NO_SIDE_EFFECTS__
|
|
1000
1014
|
*/
|
|
1001
|
-
declare function useArrayMap<T, U = T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => U): UseArrayMapReturn<U>;
|
|
1015
|
+
declare function useArrayMap<T$1, U$1 = T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => U$1): UseArrayMapReturn<U$1>;
|
|
1002
1016
|
//#endregion
|
|
1003
1017
|
//#region useArrayReduce/index.d.ts
|
|
1004
|
-
type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValue: CV, currentIndex: number) => R;
|
|
1018
|
+
type UseArrayReducer<PV, CV, R$1> = (previousValue: PV, currentValue: CV, currentIndex: number) => R$1;
|
|
1005
1019
|
/**
|
|
1006
1020
|
* Reactive `Array.reduce`
|
|
1007
1021
|
*
|
|
@@ -1013,7 +1027,7 @@ type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValue: CV, currentI
|
|
|
1013
1027
|
*
|
|
1014
1028
|
* @__NO_SIDE_EFFECTS__
|
|
1015
1029
|
*/
|
|
1016
|
-
declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<T, T, T>): ComputedRef<T>;
|
|
1030
|
+
declare function useArrayReduce<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, reducer: UseArrayReducer<T$1, T$1, T$1>): ComputedRef<T$1>;
|
|
1017
1031
|
/**
|
|
1018
1032
|
* Reactive `Array.reduce`
|
|
1019
1033
|
*
|
|
@@ -1026,7 +1040,7 @@ declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>
|
|
|
1026
1040
|
*
|
|
1027
1041
|
* @__NO_SIDE_EFFECTS__
|
|
1028
1042
|
*/
|
|
1029
|
-
declare function useArrayReduce<T, U>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<U, T, U>, initialValue: MaybeRefOrGetter<U>): ComputedRef<U>;
|
|
1043
|
+
declare function useArrayReduce<T$1, U$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, reducer: UseArrayReducer<U$1, T$1, U$1>, initialValue: MaybeRefOrGetter<U$1>): ComputedRef<U$1>;
|
|
1030
1044
|
//#endregion
|
|
1031
1045
|
//#region useArraySome/index.d.ts
|
|
1032
1046
|
type UseArraySomeReturn = ComputedRef<boolean>;
|
|
@@ -1041,10 +1055,10 @@ type UseArraySomeReturn = ComputedRef<boolean>;
|
|
|
1041
1055
|
*
|
|
1042
1056
|
* @__NO_SIDE_EFFECTS__
|
|
1043
1057
|
*/
|
|
1044
|
-
declare function useArraySome<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArraySomeReturn;
|
|
1058
|
+
declare function useArraySome<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArraySomeReturn;
|
|
1045
1059
|
//#endregion
|
|
1046
1060
|
//#region useArrayUnique/index.d.ts
|
|
1047
|
-
type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
1061
|
+
type UseArrayUniqueReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
1048
1062
|
/**
|
|
1049
1063
|
* reactive unique array
|
|
1050
1064
|
* @see https://vueuse.org/useArrayUnique
|
|
@@ -1054,7 +1068,7 @@ type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
|
1054
1068
|
*
|
|
1055
1069
|
* @__NO_SIDE_EFFECTS__
|
|
1056
1070
|
*/
|
|
1057
|
-
declare function useArrayUnique<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, compareFn?: (a: T, b: T, array: T[]) => boolean): UseArrayUniqueReturn<T>;
|
|
1071
|
+
declare function useArrayUnique<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, compareFn?: (a: T$1, b: T$1, array: T$1[]) => boolean): UseArrayUniqueReturn<T$1>;
|
|
1058
1072
|
//#endregion
|
|
1059
1073
|
//#region useCounter/index.d.ts
|
|
1060
1074
|
interface UseCounterOptions {
|
|
@@ -1140,7 +1154,7 @@ type UseDateFormatReturn = ComputedRef<string>;
|
|
|
1140
1154
|
declare function useDateFormat(date: MaybeRefOrGetter<DateLike>, formatStr?: MaybeRefOrGetter<string>, options?: UseDateFormatOptions): UseDateFormatReturn;
|
|
1141
1155
|
//#endregion
|
|
1142
1156
|
//#region useDebounceFn/index.d.ts
|
|
1143
|
-
type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
1157
|
+
type UseDebounceFnReturn<T$1 extends FunctionArgs> = PromisifyFn<T$1>;
|
|
1144
1158
|
/**
|
|
1145
1159
|
* Debounce execution of a function.
|
|
1146
1160
|
*
|
|
@@ -1153,7 +1167,7 @@ type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
|
1153
1167
|
*
|
|
1154
1168
|
* @__NO_SIDE_EFFECTS__
|
|
1155
1169
|
*/
|
|
1156
|
-
declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T>;
|
|
1170
|
+
declare function useDebounceFn<T$1 extends FunctionArgs>(fn: T$1, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T$1>;
|
|
1157
1171
|
//#endregion
|
|
1158
1172
|
//#region useInterval/index.d.ts
|
|
1159
1173
|
interface UseIntervalOptions<Controls extends boolean> {
|
|
@@ -1213,7 +1227,7 @@ type UseIntervalFnReturn = Pausable;
|
|
|
1213
1227
|
* @param interval
|
|
1214
1228
|
* @param options
|
|
1215
1229
|
*/
|
|
1216
|
-
declare function useIntervalFn(cb: Fn
|
|
1230
|
+
declare function useIntervalFn(cb: Fn, interval?: MaybeRefOrGetter<number>, options?: UseIntervalFnOptions): UseIntervalFnReturn;
|
|
1217
1231
|
//#endregion
|
|
1218
1232
|
//#region useLastChanged/index.d.ts
|
|
1219
1233
|
interface UseLastChangedOptions<Immediate extends boolean, InitialValue extends number | null | undefined = undefined> extends WatchOptions<Immediate> {
|
|
@@ -1248,7 +1262,7 @@ declare function useLastChanged(source: WatchSource, options: UseLastChangedOpti
|
|
|
1248
1262
|
*
|
|
1249
1263
|
* @__NO_SIDE_EFFECTS__
|
|
1250
1264
|
*/
|
|
1251
|
-
declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T>;
|
|
1265
|
+
declare function useThrottleFn<T$1 extends FunctionArgs>(fn: T$1, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T$1>;
|
|
1252
1266
|
//#endregion
|
|
1253
1267
|
//#region useTimeoutFn/index.d.ts
|
|
1254
1268
|
interface UseTimeoutFnOptions {
|
|
@@ -1286,7 +1300,7 @@ interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOption
|
|
|
1286
1300
|
/**
|
|
1287
1301
|
* Callback on timeout
|
|
1288
1302
|
*/
|
|
1289
|
-
callback?: Fn
|
|
1303
|
+
callback?: Fn;
|
|
1290
1304
|
}
|
|
1291
1305
|
type UseTimoutReturn = ComputedRef<boolean> | {
|
|
1292
1306
|
readonly ready: ComputedRef<boolean>;
|
|
@@ -1345,27 +1359,27 @@ declare function useToString(value: MaybeRefOrGetter<unknown>): ComputedRef<stri
|
|
|
1345
1359
|
//#region useToggle/index.d.ts
|
|
1346
1360
|
type ToggleFn = (value?: boolean) => void;
|
|
1347
1361
|
type UseToggleReturn = [ShallowRef<boolean>, ToggleFn] | ToggleFn;
|
|
1348
|
-
interface UseToggleOptions<Truthy, Falsy> {
|
|
1362
|
+
interface UseToggleOptions<Truthy, Falsy$1> {
|
|
1349
1363
|
truthyValue?: MaybeRefOrGetter<Truthy>;
|
|
1350
|
-
falsyValue?: MaybeRefOrGetter<Falsy>;
|
|
1364
|
+
falsyValue?: MaybeRefOrGetter<Falsy$1>;
|
|
1351
1365
|
}
|
|
1352
|
-
declare function useToggle<Truthy, Falsy, T = Truthy | Falsy>(initialValue: Ref<T>, options?: UseToggleOptions<Truthy, Falsy>): (value?: T) => T;
|
|
1353
|
-
declare function useToggle<Truthy = true, Falsy = false, T = Truthy | Falsy>(initialValue?: T, options?: UseToggleOptions<Truthy, Falsy>): [ShallowRef<T>, (value?: T) => T];
|
|
1366
|
+
declare function useToggle<Truthy, Falsy$1, T$1 = Truthy | Falsy$1>(initialValue: Ref<T$1>, options?: UseToggleOptions<Truthy, Falsy$1>): (value?: T$1) => T$1;
|
|
1367
|
+
declare function useToggle<Truthy = true, Falsy$1 = false, T$1 = Truthy | Falsy$1>(initialValue?: T$1, options?: UseToggleOptions<Truthy, Falsy$1>): [ShallowRef<T$1>, (value?: T$1) => T$1];
|
|
1354
1368
|
//#endregion
|
|
1355
1369
|
//#region watchArray/index.d.ts
|
|
1356
|
-
declare type WatchArrayCallback<V = any, OV = any> = (value: V, oldValue: OV, added: V, removed: OV, onCleanup: (cleanupFn: () => void) => void) => any;
|
|
1370
|
+
declare type WatchArrayCallback<V$1 = any, OV = any> = (value: V$1, oldValue: OV, added: V$1, removed: OV, onCleanup: (cleanupFn: () => void) => void) => any;
|
|
1357
1371
|
/**
|
|
1358
1372
|
* Watch for an array with additions and removals.
|
|
1359
1373
|
*
|
|
1360
1374
|
* @see https://vueuse.org/watchArray
|
|
1361
1375
|
*/
|
|
1362
|
-
declare function watchArray<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T[]> | T[], cb: WatchArrayCallback<T[], Immediate extends true ? T[] | undefined : T[]>, options?: WatchOptions<Immediate>): vue0.WatchHandle;
|
|
1376
|
+
declare function watchArray<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1[]> | T$1[], cb: WatchArrayCallback<T$1[], Immediate extends true ? T$1[] | undefined : T$1[]>, options?: WatchOptions<Immediate>): vue0.WatchHandle;
|
|
1363
1377
|
//#endregion
|
|
1364
1378
|
//#region watchWithFilter/index.d.ts
|
|
1365
1379
|
interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {}
|
|
1366
|
-
declare function watchWithFilter<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1367
|
-
declare function watchWithFilter<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1368
|
-
declare function watchWithFilter<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1380
|
+
declare function watchWithFilter<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1381
|
+
declare function watchWithFilter<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1382
|
+
declare function watchWithFilter<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
1369
1383
|
//#endregion
|
|
1370
1384
|
//#region watchAtMost/index.d.ts
|
|
1371
1385
|
interface WatchAtMostOptions<Immediate> extends WatchWithFilterOptions<Immediate> {
|
|
@@ -1377,23 +1391,23 @@ interface WatchAtMostReturn {
|
|
|
1377
1391
|
resume: () => void;
|
|
1378
1392
|
count: ShallowRef<number>;
|
|
1379
1393
|
}
|
|
1380
|
-
declare function watchAtMost<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
1381
|
-
declare function watchAtMost<T, Immediate extends Readonly<boolean> = false>(sources: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
1394
|
+
declare function watchAtMost<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
1395
|
+
declare function watchAtMost<T$1, Immediate extends Readonly<boolean> = false>(sources: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
1382
1396
|
//#endregion
|
|
1383
1397
|
//#region watchDebounced/index.d.ts
|
|
1384
1398
|
interface WatchDebouncedOptions<Immediate> extends WatchOptions<Immediate>, DebounceFilterOptions {
|
|
1385
1399
|
debounce?: MaybeRefOrGetter<number>;
|
|
1386
1400
|
}
|
|
1387
|
-
declare function watchDebounced<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1388
|
-
declare function watchDebounced<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1389
|
-
declare function watchDebounced<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1401
|
+
declare function watchDebounced<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1402
|
+
declare function watchDebounced<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1403
|
+
declare function watchDebounced<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
1390
1404
|
/** @deprecated use `watchDebounced` instead */
|
|
1391
1405
|
declare const debouncedWatch: typeof watchDebounced;
|
|
1392
1406
|
//#endregion
|
|
1393
1407
|
//#region watchDeep/index.d.ts
|
|
1394
|
-
declare function watchDeep<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1395
|
-
declare function watchDeep<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1396
|
-
declare function watchDeep<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1408
|
+
declare function watchDeep<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1409
|
+
declare function watchDeep<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1410
|
+
declare function watchDeep<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
1397
1411
|
//#endregion
|
|
1398
1412
|
//#region watchIgnorable/index.d.ts
|
|
1399
1413
|
type IgnoredUpdater = (updater: () => void) => void;
|
|
@@ -1403,21 +1417,21 @@ interface WatchIgnorableReturn {
|
|
|
1403
1417
|
ignorePrevAsyncUpdates: IgnoredPrevAsyncUpdates;
|
|
1404
1418
|
stop: WatchStopHandle;
|
|
1405
1419
|
}
|
|
1406
|
-
declare function watchIgnorable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1407
|
-
declare function watchIgnorable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1408
|
-
declare function watchIgnorable<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1420
|
+
declare function watchIgnorable<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1421
|
+
declare function watchIgnorable<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1422
|
+
declare function watchIgnorable<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
1409
1423
|
/** @deprecated use `watchIgnorable` instead */
|
|
1410
1424
|
declare const ignorableWatch: typeof watchIgnorable;
|
|
1411
1425
|
//#endregion
|
|
1412
1426
|
//#region watchImmediate/index.d.ts
|
|
1413
|
-
declare function watchImmediate<T extends Readonly<WatchSource<unknown>[]>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1414
|
-
declare function watchImmediate<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1415
|
-
declare function watchImmediate<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1427
|
+
declare function watchImmediate<T$1 extends Readonly<WatchSource<unknown>[]>>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, true>>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1428
|
+
declare function watchImmediate<T$1>(source: WatchSource<T$1>, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1429
|
+
declare function watchImmediate<T$1 extends object>(source: T$1, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
1416
1430
|
//#endregion
|
|
1417
1431
|
//#region watchOnce/index.d.ts
|
|
1418
|
-
declare function watchOnce<T extends Readonly<WatchSource<unknown>[]>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1419
|
-
declare function watchOnce<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1420
|
-
declare function watchOnce<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1432
|
+
declare function watchOnce<T$1 extends Readonly<WatchSource<unknown>[]>>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, true>>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1433
|
+
declare function watchOnce<T$1>(source: WatchSource<T$1>, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1434
|
+
declare function watchOnce<T$1 extends object>(source: T$1, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
1421
1435
|
//#endregion
|
|
1422
1436
|
//#region watchPausable/index.d.ts
|
|
1423
1437
|
interface WatchPausableReturn extends Pausable {
|
|
@@ -1427,9 +1441,9 @@ type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & Pausa
|
|
|
1427
1441
|
/**
|
|
1428
1442
|
* @deprecated This function will be removed in future version.
|
|
1429
1443
|
*/
|
|
1430
|
-
declare function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1431
|
-
declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1432
|
-
declare function watchPausable<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1444
|
+
declare function watchPausable<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1445
|
+
declare function watchPausable<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1446
|
+
declare function watchPausable<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
1433
1447
|
/** @deprecated use `watchPausable` instead */
|
|
1434
1448
|
declare const pausableWatch: typeof watchPausable;
|
|
1435
1449
|
//#endregion
|
|
@@ -1439,9 +1453,9 @@ interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
|
|
|
1439
1453
|
trailing?: boolean;
|
|
1440
1454
|
leading?: boolean;
|
|
1441
1455
|
}
|
|
1442
|
-
declare function watchThrottled<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1443
|
-
declare function watchThrottled<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1444
|
-
declare function watchThrottled<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1456
|
+
declare function watchThrottled<T$1 extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1457
|
+
declare function watchThrottled<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1458
|
+
declare function watchThrottled<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
1445
1459
|
/** @deprecated use `watchThrottled` instead */
|
|
1446
1460
|
declare const throttledWatch: typeof watchThrottled;
|
|
1447
1461
|
//#endregion
|
|
@@ -1451,10 +1465,10 @@ interface WatchTriggerableReturn<FnReturnT = void> extends WatchIgnorableReturn
|
|
|
1451
1465
|
trigger: () => FnReturnT;
|
|
1452
1466
|
}
|
|
1453
1467
|
type OnCleanup = (cleanupFn: () => void) => void;
|
|
1454
|
-
type WatchTriggerableCallback<V = any, OV = any, R = void> = (value: V, oldValue: OV, onCleanup: OnCleanup) => R;
|
|
1455
|
-
declare function watchTriggerable<T extends Readonly<WatchSource<unknown>[]>, FnReturnT>(sources: [...T], cb: WatchTriggerableCallback<MapSources<T>, MapOldSources<T, true>, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1456
|
-
declare function watchTriggerable<T, FnReturnT>(source: WatchSource<T>, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1457
|
-
declare function watchTriggerable<T extends object, FnReturnT>(source: T, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1468
|
+
type WatchTriggerableCallback<V$1 = any, OV = any, R$1 = void> = (value: V$1, oldValue: OV, onCleanup: OnCleanup) => R$1;
|
|
1469
|
+
declare function watchTriggerable<T$1 extends Readonly<WatchSource<unknown>[]>, FnReturnT>(sources: [...T$1], cb: WatchTriggerableCallback<MapSources<T$1>, MapOldSources<T$1, true>, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1470
|
+
declare function watchTriggerable<T$1, FnReturnT>(source: WatchSource<T$1>, cb: WatchTriggerableCallback<T$1, T$1 | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1471
|
+
declare function watchTriggerable<T$1 extends object, FnReturnT>(source: T$1, cb: WatchTriggerableCallback<T$1, T$1 | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
1458
1472
|
//#endregion
|
|
1459
1473
|
//#region whenever/index.d.ts
|
|
1460
1474
|
interface WheneverOptions extends WatchOptions {
|
|
@@ -1472,6 +1486,6 @@ interface WheneverOptions extends WatchOptions {
|
|
|
1472
1486
|
*
|
|
1473
1487
|
* @see https://vueuse.org/whenever
|
|
1474
1488
|
*/
|
|
1475
|
-
declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions): vue0.WatchHandle;
|
|
1489
|
+
declare function whenever<T$1>(source: WatchSource<T$1 | false | null | undefined>, cb: WatchCallback<T$1>, options?: WheneverOptions): vue0.WatchHandle;
|
|
1476
1490
|
//#endregion
|
|
1477
|
-
export { AnyFn, ArgumentsType, Arrayable, Awaitable, Awaited, ComputedEagerOptions, ComputedEagerReturn, ComputedRefWithControl, ComputedWithControlRef, ComputedWithControlRefExtra, ConfigurableEventFilter, ConfigurableFlush, ConfigurableFlushSync, ControlledRefOptions, CreateGlobalStateReturn, CreateInjectionStateOptions, CreateRefReturn, DateLike, DebounceFilterOptions, DeepMaybeRef, ElementOf, EventFilter, EventHook, EventHookOff, EventHookOn, EventHookReturn, EventHookTrigger, ExtendRefOptions, ExtendRefReturn, Fn
|
|
1491
|
+
export { AnyFn, ArgumentsType, Arrayable, Awaitable, Awaited, ComputedEagerOptions, ComputedEagerReturn, ComputedRefWithControl, ComputedWithControlRef, ComputedWithControlRefExtra, ConfigurableEventFilter, ConfigurableFlush, ConfigurableFlushSync, ControlledRefOptions, CreateGlobalStateReturn, CreateInjectionStateOptions, CreateInjectionStateReturn, CreateRefReturn, DateLike, DebounceFilterOptions, DeepMaybeRef, ElementOf, EventFilter, EventHook, EventHookOff, EventHookOn, EventHookReturn, EventHookTrigger, ExtendRefOptions, ExtendRefReturn, Fn, FunctionArgs, FunctionWrapperOptions, IfAny, IgnoredPrevAsyncUpdates, IgnoredUpdater, InstanceProxy, IsAny, IsDefinedReturn, ManualResetRefReturn, MapOldSources, MapSources, MultiWatchSources, Mutable, Pausable, PausableFilterOptions, Promisify, PromisifyFn, ProvideLocalReturn, Reactified, ReactifyNested, ReactifyObjectOptions, ReactifyObjectReturn, ReactifyOptions, ReactifyReturn, ReactiveComputedReturn, ReactiveOmitPredicate, ReactiveOmitReturn, ReactivePickPredicate, ReactivePickReturn, ReadonlyRefOrGetter, RefAutoResetReturn, RefDebouncedReturn, RefThrottledReturn, RemovableRef, ShallowOrDeepRef, ShallowUnwrapRef, SharedComposableReturn, SingletonPromiseReturn, Stoppable, SyncRefOptions, SyncRefsOptions, ThrottleFilterOptions, TimerHandle, ToRefsOptions, ToggleFn, UntilArrayInstance, UntilBaseInstance, UntilToMatchOptions, UntilValueInstance, UseArrayDifferenceOptions, UseArrayDifferenceReturn, UseArrayEveryReturn, UseArrayFilterReturn, UseArrayFindIndexReturn, UseArrayFindLastReturn, UseArrayFindReturn, UseArrayIncludesComparatorFn, UseArrayIncludesOptions, UseArrayIncludesReturn, UseArrayJoinReturn, UseArrayMapReturn, UseArrayReducer, UseArraySomeReturn, UseArrayUniqueReturn, UseCounterOptions, UseCounterReturn, UseDateFormatOptions, UseDateFormatReturn, UseDebounceFnReturn, UseIntervalControls, UseIntervalFnOptions, UseIntervalFnReturn, UseIntervalOptions, UseIntervalReturn, UseLastChangedOptions, UseLastChangedReturn, UseTimeoutFnOptions, UseTimeoutFnReturn, UseTimeoutOptions, UseTimoutReturn, UseToNumberOptions, UseToggleOptions, UseToggleReturn, WatchArrayCallback, WatchAtMostOptions, WatchAtMostReturn, WatchDebouncedOptions, WatchIgnorableReturn, WatchOptionFlush, WatchPausableOptions, WatchPausableReturn, WatchThrottledOptions, WatchTriggerableCallback, WatchTriggerableReturn, WatchWithFilterOptions, WheneverOptions, WritableComputedRefWithControl, assert, autoResetRef, bypassFilter, camelize, clamp, computedEager, computedWithControl, containsProp, controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, createReactiveFn, createRef, createSharedComposable, createSingletonPromise, debounceFilter, debouncedRef, debouncedWatch, eagerComputed, extendRef, formatDate, get, getLifeCycleTarget, hasOwn, hyphenate, identity, ignorableWatch, increaseWithUnit, injectLocal, invoke, isClient, isDef, isDefined, isIOS, isObject, isWorker, makeDestructurable, noop, normalizeDate, notNullish, now, objectEntries, objectOmit, objectPick, pausableFilter, pausableWatch, promiseTimeout, provideLocal, pxValue, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refManualReset, refThrottled, refWithControl, set, syncRef, syncRefs, throttleFilter, throttledRef, throttledWatch, timestamp, toArray, toReactive, toRef, toRefs, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayFindLast, useArrayIncludes, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useCounter, useDateFormat, useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, useToggle, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };
|