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