@vueuse/shared 14.0.0-alpha.1 → 14.0.0-alpha.3
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 +133 -96
- package/dist/index.iife.js +442 -416
- package/dist/index.iife.min.js +1 -1
- package/dist/index.js +467 -439
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import * as vue0 from "vue";
|
|
2
|
-
import { ComputedGetter, ComputedRef, InjectionKey, MaybeRef,
|
|
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";
|
|
3
3
|
|
|
4
4
|
//#region computedEager/index.d.ts
|
|
5
5
|
type ComputedEagerOptions = WatchOptionsBase;
|
|
6
6
|
type ComputedEagerReturn<T = any> = Readonly<ShallowRef<T>>;
|
|
7
7
|
/**
|
|
8
|
+
*
|
|
9
|
+
* @deprecated This function will be removed in future version.
|
|
10
|
+
*
|
|
8
11
|
* Note: If you are using Vue 3.4+, you can straight use computed instead.
|
|
9
12
|
* Because in Vue 3.4+, if computed new value does not change,
|
|
10
13
|
* computed, effect, watch, watchEffect, render dependencies will not be triggered.
|
|
@@ -15,6 +18,8 @@ type ComputedEagerReturn<T = any> = Readonly<ShallowRef<T>>;
|
|
|
15
18
|
* @returns readonly shallowRef
|
|
16
19
|
*/
|
|
17
20
|
declare function computedEager<T>(fn: () => T, options?: ComputedEagerOptions): ComputedEagerReturn<T>;
|
|
21
|
+
/** @deprecated use `computedEager` instead */
|
|
22
|
+
declare const eagerComputed: typeof computedEager;
|
|
18
23
|
//#endregion
|
|
19
24
|
//#region computedWithControl/index.d.ts
|
|
20
25
|
interface ComputedWithControlRefExtra {
|
|
@@ -28,6 +33,8 @@ interface WritableComputedRefWithControl<T> extends WritableComputedRef<T>, Comp
|
|
|
28
33
|
type ComputedWithControlRef<T = any> = ComputedRefWithControl<T> | WritableComputedRefWithControl<T>;
|
|
29
34
|
declare function computedWithControl<T, S>(source: WatchSource<S> | WatchSource<S>[], fn: ComputedGetter<T>, options?: WatchOptions): ComputedRefWithControl<T>;
|
|
30
35
|
declare function computedWithControl<T, S>(source: WatchSource<S> | WatchSource<S>[], fn: WritableComputedOptions<T>, options?: WatchOptions): WritableComputedRefWithControl<T>;
|
|
36
|
+
/** @deprecated use `computedWithControl` instead */
|
|
37
|
+
declare const controlledComputed: typeof computedWithControl;
|
|
31
38
|
//#endregion
|
|
32
39
|
//#region utils/types.d.ts
|
|
33
40
|
/**
|
|
@@ -103,13 +110,14 @@ interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
|
103
110
|
*/
|
|
104
111
|
start: (...args: StartFnArgs) => void;
|
|
105
112
|
}
|
|
113
|
+
type WatchOptionFlush = WatchOptions['flush'];
|
|
106
114
|
interface ConfigurableFlush {
|
|
107
115
|
/**
|
|
108
116
|
* Timing for monitoring changes, refer to WatchOptions for more details
|
|
109
117
|
*
|
|
110
118
|
* @default 'pre'
|
|
111
119
|
*/
|
|
112
|
-
flush?:
|
|
120
|
+
flush?: WatchOptionFlush;
|
|
113
121
|
}
|
|
114
122
|
interface ConfigurableFlushSync {
|
|
115
123
|
/**
|
|
@@ -118,7 +126,7 @@ interface ConfigurableFlushSync {
|
|
|
118
126
|
*
|
|
119
127
|
* @default 'sync'
|
|
120
128
|
*/
|
|
121
|
-
flush?:
|
|
129
|
+
flush?: WatchOptionFlush;
|
|
122
130
|
}
|
|
123
131
|
type MultiWatchSources = (WatchSource<unknown> | object)[];
|
|
124
132
|
type MapSources<T> = { [K in keyof T]: T[K] extends WatchSource<infer V> ? V : never };
|
|
@@ -133,6 +141,7 @@ type IsAny<T> = IfAny<T, true, false>;
|
|
|
133
141
|
* Universal timer handle that works in both browser and Node.js environments
|
|
134
142
|
*/
|
|
135
143
|
type TimerHandle = ReturnType<typeof setTimeout> | undefined;
|
|
144
|
+
type InstanceProxy = NonNullable<NonNullable<ReturnType<typeof getCurrentInstance>>['proxy']>;
|
|
136
145
|
//#endregion
|
|
137
146
|
//#region createEventHook/index.d.ts
|
|
138
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);
|
|
@@ -178,7 +187,7 @@ interface DebounceFilterOptions {
|
|
|
178
187
|
* The maximum time allowed to be delayed before it's invoked.
|
|
179
188
|
* In milliseconds.
|
|
180
189
|
*/
|
|
181
|
-
maxWait?: MaybeRefOrGetter
|
|
190
|
+
maxWait?: MaybeRefOrGetter<number>;
|
|
182
191
|
/**
|
|
183
192
|
* Whether to reject the last call if it's been cancel.
|
|
184
193
|
*
|
|
@@ -194,12 +203,12 @@ declare const bypassFilter: EventFilter;
|
|
|
194
203
|
/**
|
|
195
204
|
* Create an EventFilter that debounce the events
|
|
196
205
|
*/
|
|
197
|
-
declare function debounceFilter(ms: MaybeRefOrGetter
|
|
206
|
+
declare function debounceFilter(ms: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): EventFilter<any[], any, AnyFn>;
|
|
198
207
|
interface ThrottleFilterOptions {
|
|
199
208
|
/**
|
|
200
209
|
* The maximum time allowed to be delayed before it's invoked.
|
|
201
210
|
*/
|
|
202
|
-
delay: MaybeRefOrGetter
|
|
211
|
+
delay: MaybeRefOrGetter<number>;
|
|
203
212
|
/**
|
|
204
213
|
* Whether to invoke on the trailing edge of the timeout.
|
|
205
214
|
*/
|
|
@@ -216,7 +225,7 @@ interface ThrottleFilterOptions {
|
|
|
216
225
|
/**
|
|
217
226
|
* Create an EventFilter that throttle the events
|
|
218
227
|
*/
|
|
219
|
-
declare function throttleFilter(ms: MaybeRefOrGetter
|
|
228
|
+
declare function throttleFilter(ms: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): EventFilter;
|
|
220
229
|
declare function throttleFilter(options: ThrottleFilterOptions): EventFilter;
|
|
221
230
|
interface PausableFilterOptions {
|
|
222
231
|
/**
|
|
@@ -401,8 +410,8 @@ declare function extendRef<R extends Ref<any>, Extend extends object, Options ex
|
|
|
401
410
|
/**
|
|
402
411
|
* Shorthand for accessing `ref.value`
|
|
403
412
|
*/
|
|
404
|
-
declare function get<T>(ref: MaybeRef
|
|
405
|
-
declare function get<T, K extends keyof T>(ref: MaybeRef
|
|
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];
|
|
406
415
|
//#endregion
|
|
407
416
|
//#region injectLocal/index.d.ts
|
|
408
417
|
/**
|
|
@@ -427,6 +436,9 @@ declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
|
|
|
427
436
|
//#region makeDestructurable/index.d.ts
|
|
428
437
|
declare function makeDestructurable<T extends Record<string, unknown>, A extends readonly any[]>(obj: T, arr: A): T & A;
|
|
429
438
|
//#endregion
|
|
439
|
+
//#region provideLocal/map.d.ts
|
|
440
|
+
type LocalProvidedKey<T> = InjectionKey<T> | string | number;
|
|
441
|
+
//#endregion
|
|
430
442
|
//#region provideLocal/index.d.ts
|
|
431
443
|
type ProvideLocalReturn = void;
|
|
432
444
|
/**
|
|
@@ -438,10 +450,10 @@ type ProvideLocalReturn = void;
|
|
|
438
450
|
* const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1
|
|
439
451
|
* ```
|
|
440
452
|
*/
|
|
441
|
-
declare function provideLocal<T, K =
|
|
453
|
+
declare function provideLocal<T, K = LocalProvidedKey<T>>(key: K, value: K extends InjectionKey<infer V> ? V : T): ProvideLocalReturn;
|
|
442
454
|
//#endregion
|
|
443
455
|
//#region reactify/index.d.ts
|
|
444
|
-
type Reactified<T, Computed extends boolean> = T extends ((...args: infer A) => infer R) ? (...args: { [K in keyof A]: Computed extends true ? MaybeRefOrGetter
|
|
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;
|
|
445
457
|
type ReactifyReturn<T extends AnyFn = AnyFn, K extends boolean = true> = Reactified<T, K>;
|
|
446
458
|
interface ReactifyOptions<T extends boolean> {
|
|
447
459
|
/**
|
|
@@ -462,6 +474,8 @@ interface ReactifyOptions<T extends boolean> {
|
|
|
462
474
|
* @__NO_SIDE_EFFECTS__
|
|
463
475
|
*/
|
|
464
476
|
declare function reactify<T extends AnyFn, K extends boolean = true>(fn: T, options?: ReactifyOptions<K>): ReactifyReturn<T, K>;
|
|
477
|
+
/** @deprecated use `reactify` instead */
|
|
478
|
+
declare const createReactiveFn: typeof reactify;
|
|
465
479
|
//#endregion
|
|
466
480
|
//#region reactifyObject/index.d.ts
|
|
467
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] };
|
|
@@ -510,7 +524,9 @@ type RefAutoResetReturn<T = any> = Ref<T>;
|
|
|
510
524
|
* @param defaultValue The value which will be set.
|
|
511
525
|
* @param afterMs A zero-or-greater delay in milliseconds.
|
|
512
526
|
*/
|
|
513
|
-
declare function refAutoReset<T>(defaultValue: MaybeRefOrGetter
|
|
527
|
+
declare function refAutoReset<T>(defaultValue: MaybeRefOrGetter<T>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T>;
|
|
528
|
+
/** @deprecated use `refAutoReset` instead */
|
|
529
|
+
declare const autoResetRef: typeof refAutoReset;
|
|
514
530
|
//#endregion
|
|
515
531
|
//#region refDebounced/index.d.ts
|
|
516
532
|
type RefDebouncedReturn<T = any> = Readonly<Ref<T>>;
|
|
@@ -519,7 +535,11 @@ type RefDebouncedReturn<T = any> = Readonly<Ref<T>>;
|
|
|
519
535
|
*
|
|
520
536
|
* @return A new debounced ref.
|
|
521
537
|
*/
|
|
522
|
-
declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter
|
|
538
|
+
declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T>;
|
|
539
|
+
/** @deprecated use `refDebounced` instead */
|
|
540
|
+
declare const debouncedRef: typeof refDebounced;
|
|
541
|
+
/** @deprecated use `refDebounced` instead */
|
|
542
|
+
declare const useDebounce: typeof refDebounced;
|
|
523
543
|
//#endregion
|
|
524
544
|
//#region refDefault/index.d.ts
|
|
525
545
|
/**
|
|
@@ -529,6 +549,24 @@ declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter$1<number>,
|
|
|
529
549
|
*/
|
|
530
550
|
declare function refDefault<T>(source: Ref<T | undefined | null>, defaultValue: T): Ref<T>;
|
|
531
551
|
//#endregion
|
|
552
|
+
//#region refManualReset/index.d.ts
|
|
553
|
+
/**
|
|
554
|
+
* Define the shape of a ref that supports manual reset functionality.
|
|
555
|
+
*
|
|
556
|
+
* This interface extends the standard `Ref` type from Vue and adds a `reset` method.
|
|
557
|
+
* The `reset` method allows the ref to be manually reset to its default value.
|
|
558
|
+
*/
|
|
559
|
+
interface ManualResetRefReturn<T> extends Ref<T> {
|
|
560
|
+
reset: Fn$1;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* Create a ref with manual reset functionality.
|
|
564
|
+
*
|
|
565
|
+
* @see https://vueuse.org/refManualReset
|
|
566
|
+
* @param defaultValue The value which will be set.
|
|
567
|
+
*/
|
|
568
|
+
declare function refManualReset<T>(defaultValue: MaybeRefOrGetter<T>): ManualResetRefReturn<T>;
|
|
569
|
+
//#endregion
|
|
532
570
|
//#region refThrottled/index.d.ts
|
|
533
571
|
type RefThrottledReturn<T = any> = Ref<T>;
|
|
534
572
|
/**
|
|
@@ -541,6 +579,10 @@ type RefThrottledReturn<T = any> = Ref<T>;
|
|
|
541
579
|
* @param leading if true, update the value on the leading edge of the ms timeout
|
|
542
580
|
*/
|
|
543
581
|
declare function refThrottled<T = any>(value: Ref<T>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T>;
|
|
582
|
+
/** @deprecated use `refThrottled` instead */
|
|
583
|
+
declare const throttledRef: typeof refThrottled;
|
|
584
|
+
/** @deprecated use `refThrottled` instead */
|
|
585
|
+
declare const useThrottle: typeof refThrottled;
|
|
544
586
|
//#endregion
|
|
545
587
|
//#region refWithControl/index.d.ts
|
|
546
588
|
interface ControlledRefOptions<T> {
|
|
@@ -570,9 +612,7 @@ declare function refWithControl<T>(initial: T, options?: ControlledRefOptions<T>
|
|
|
570
612
|
peek: () => T;
|
|
571
613
|
lay: (v: T) => void;
|
|
572
614
|
}> & vue0.Ref<T, T>;
|
|
573
|
-
/**
|
|
574
|
-
* Alias for `refWithControl`
|
|
575
|
-
*/
|
|
615
|
+
/** @deprecated use `refWithControl` instead */
|
|
576
616
|
declare const controlledRef: typeof refWithControl;
|
|
577
617
|
//#endregion
|
|
578
618
|
//#region set/index.d.ts
|
|
@@ -681,7 +721,7 @@ declare function syncRefs<T>(source: WatchSource<T>, targets: Ref<T> | Ref<T>[],
|
|
|
681
721
|
* @see https://vueuse.org/toReactive
|
|
682
722
|
* @param objectRef A ref of object
|
|
683
723
|
*/
|
|
684
|
-
declare function toReactive<T extends object>(objectRef: MaybeRef
|
|
724
|
+
declare function toReactive<T extends object>(objectRef: MaybeRef<T>): UnwrapNestedRefs<T>;
|
|
685
725
|
//#endregion
|
|
686
726
|
//#region toRef/index.d.ts
|
|
687
727
|
/**
|
|
@@ -689,14 +729,10 @@ declare function toReactive<T extends object>(objectRef: MaybeRef$1<T>): UnwrapN
|
|
|
689
729
|
*/
|
|
690
730
|
declare function toRef<T>(r: () => T): Readonly<Ref<T>>;
|
|
691
731
|
declare function toRef<T>(r: ComputedRef<T>): ComputedRef<T>;
|
|
692
|
-
declare function toRef<T>(r: MaybeRefOrGetter
|
|
732
|
+
declare function toRef<T>(r: MaybeRefOrGetter<T>): Ref<T>;
|
|
693
733
|
declare function toRef<T>(r: T): Ref<T>;
|
|
694
734
|
declare function toRef<T extends object, K extends keyof T>(object: T, key: K): ToRef<T[K]>;
|
|
695
735
|
declare function toRef<T extends object, K extends keyof T>(object: T, key: K, defaultValue: T[K]): ToRef<Exclude<T[K], undefined>>;
|
|
696
|
-
/**
|
|
697
|
-
* @deprecated use `toRef` instead
|
|
698
|
-
*/
|
|
699
|
-
declare const resolveRef: typeof toRef;
|
|
700
736
|
//#endregion
|
|
701
737
|
//#region toRefs/index.d.ts
|
|
702
738
|
interface ToRefsOptions {
|
|
@@ -705,7 +741,7 @@ interface ToRefsOptions {
|
|
|
705
741
|
*
|
|
706
742
|
* @default true
|
|
707
743
|
*/
|
|
708
|
-
replaceRef?: MaybeRefOrGetter
|
|
744
|
+
replaceRef?: MaybeRefOrGetter<boolean>;
|
|
709
745
|
}
|
|
710
746
|
/**
|
|
711
747
|
* Extended `toRefs` that also accepts refs of an object.
|
|
@@ -714,19 +750,7 @@ interface ToRefsOptions {
|
|
|
714
750
|
* @param objectRef A ref or normal object or array.
|
|
715
751
|
* @param options Options
|
|
716
752
|
*/
|
|
717
|
-
declare function toRefs<T extends object>(objectRef: MaybeRef
|
|
718
|
-
//#endregion
|
|
719
|
-
//#region toValue/index.d.ts
|
|
720
|
-
/**
|
|
721
|
-
* Get the value of value/ref/getter.
|
|
722
|
-
*
|
|
723
|
-
* @deprecated use `toValue` from `vue` instead
|
|
724
|
-
*/
|
|
725
|
-
declare const toValue: typeof toValue$1;
|
|
726
|
-
/**
|
|
727
|
-
* @deprecated use `toValue` instead
|
|
728
|
-
*/
|
|
729
|
-
declare const resolveUnref: typeof toValue$1;
|
|
753
|
+
declare function toRefs<T extends object>(objectRef: MaybeRef<T>, options?: ToRefsOptions): ToRefs<T>;
|
|
730
754
|
//#endregion
|
|
731
755
|
//#region tryOnBeforeMount/index.d.ts
|
|
732
756
|
/**
|
|
@@ -794,7 +818,7 @@ interface UntilToMatchOptions {
|
|
|
794
818
|
*
|
|
795
819
|
* @default 'sync'
|
|
796
820
|
*/
|
|
797
|
-
flush?:
|
|
821
|
+
flush?: WatchOptionFlush;
|
|
798
822
|
/**
|
|
799
823
|
* `deep` option for internal watch
|
|
800
824
|
*
|
|
@@ -810,7 +834,7 @@ interface UntilBaseInstance<T, Not extends boolean = false> {
|
|
|
810
834
|
type Falsy$1 = false | void | null | undefined | 0 | 0n | '';
|
|
811
835
|
interface UntilValueInstance<T, Not extends boolean = false> extends UntilBaseInstance<T, Not> {
|
|
812
836
|
readonly not: UntilValueInstance<T, Not extends true ? false : true>;
|
|
813
|
-
toBe: <P = T>(value: MaybeRefOrGetter
|
|
837
|
+
toBe: <P = T>(value: MaybeRefOrGetter<P>, options?: UntilToMatchOptions) => Not extends true ? Promise<T> : Promise<P>;
|
|
814
838
|
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T & Falsy$1> : Promise<Exclude<T, Falsy$1>>;
|
|
815
839
|
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, null>> : Promise<null>;
|
|
816
840
|
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, undefined>> : Promise<undefined>;
|
|
@@ -818,7 +842,7 @@ interface UntilValueInstance<T, Not extends boolean = false> extends UntilBaseIn
|
|
|
818
842
|
}
|
|
819
843
|
interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
820
844
|
readonly not: UntilArrayInstance<T>;
|
|
821
|
-
toContains: (value: MaybeRefOrGetter
|
|
845
|
+
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T>>>, options?: UntilToMatchOptions) => Promise<T>;
|
|
822
846
|
}
|
|
823
847
|
/**
|
|
824
848
|
* Promised one-time watch for changes
|
|
@@ -833,8 +857,8 @@ interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
|
833
857
|
* alert('Counter is now larger than 7!')
|
|
834
858
|
* ```
|
|
835
859
|
*/
|
|
836
|
-
declare function until<T extends unknown[]>(r: WatchSource<T> | MaybeRefOrGetter
|
|
837
|
-
declare function until<T>(r: WatchSource<T> | MaybeRefOrGetter
|
|
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>;
|
|
838
862
|
//#endregion
|
|
839
863
|
//#region useArrayDifference/index.d.ts
|
|
840
864
|
interface UseArrayDifferenceOptions {
|
|
@@ -847,8 +871,8 @@ interface UseArrayDifferenceOptions {
|
|
|
847
871
|
symmetric?: boolean;
|
|
848
872
|
}
|
|
849
873
|
type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;
|
|
850
|
-
declare function useArrayDifference<T>(list: MaybeRefOrGetter
|
|
851
|
-
declare function useArrayDifference<T>(list: MaybeRefOrGetter
|
|
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>;
|
|
852
876
|
//#endregion
|
|
853
877
|
//#region useArrayEvery/index.d.ts
|
|
854
878
|
type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
@@ -863,7 +887,7 @@ type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
|
863
887
|
*
|
|
864
888
|
* @__NO_SIDE_EFFECTS__
|
|
865
889
|
*/
|
|
866
|
-
declare function useArrayEvery<T>(list: MaybeRefOrGetter
|
|
890
|
+
declare function useArrayEvery<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayEveryReturn;
|
|
867
891
|
//#endregion
|
|
868
892
|
//#region useArrayFilter/index.d.ts
|
|
869
893
|
type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
@@ -878,8 +902,8 @@ type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
|
878
902
|
*
|
|
879
903
|
* @__NO_SIDE_EFFECTS__
|
|
880
904
|
*/
|
|
881
|
-
declare function useArrayFilter<T, S extends T>(list: MaybeRefOrGetter
|
|
882
|
-
declare function useArrayFilter<T>(list: MaybeRefOrGetter
|
|
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>;
|
|
883
907
|
//#endregion
|
|
884
908
|
//#region useArrayFind/index.d.ts
|
|
885
909
|
type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
@@ -894,7 +918,7 @@ type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
|
894
918
|
*
|
|
895
919
|
* @__NO_SIDE_EFFECTS__
|
|
896
920
|
*/
|
|
897
|
-
declare function useArrayFind<T>(list: MaybeRefOrGetter
|
|
921
|
+
declare function useArrayFind<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindReturn<T>;
|
|
898
922
|
//#endregion
|
|
899
923
|
//#region useArrayFindIndex/index.d.ts
|
|
900
924
|
type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
@@ -909,7 +933,7 @@ type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
|
909
933
|
*
|
|
910
934
|
* @__NO_SIDE_EFFECTS__
|
|
911
935
|
*/
|
|
912
|
-
declare function useArrayFindIndex<T>(list: MaybeRefOrGetter
|
|
936
|
+
declare function useArrayFindIndex<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayFindIndexReturn;
|
|
913
937
|
//#endregion
|
|
914
938
|
//#region useArrayFindLast/index.d.ts
|
|
915
939
|
type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
@@ -924,10 +948,10 @@ type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
|
924
948
|
*
|
|
925
949
|
* @__NO_SIDE_EFFECTS__
|
|
926
950
|
*/
|
|
927
|
-
declare function useArrayFindLast<T>(list: MaybeRefOrGetter
|
|
951
|
+
declare function useArrayFindLast<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindLastReturn<T>;
|
|
928
952
|
//#endregion
|
|
929
953
|
//#region useArrayIncludes/index.d.ts
|
|
930
|
-
type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeRefOrGetter
|
|
954
|
+
type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeRefOrGetter<T>[]) => boolean);
|
|
931
955
|
interface UseArrayIncludesOptions<T, V> {
|
|
932
956
|
fromIndex?: number;
|
|
933
957
|
comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T;
|
|
@@ -942,9 +966,9 @@ type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
|
942
966
|
*
|
|
943
967
|
* @__NO_SIDE_EFFECTS__
|
|
944
968
|
*/
|
|
945
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter
|
|
946
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter
|
|
947
|
-
declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter
|
|
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;
|
|
948
972
|
//#endregion
|
|
949
973
|
//#region useArrayJoin/index.d.ts
|
|
950
974
|
type UseArrayJoinReturn = ComputedRef<string>;
|
|
@@ -959,7 +983,7 @@ type UseArrayJoinReturn = ComputedRef<string>;
|
|
|
959
983
|
*
|
|
960
984
|
* @__NO_SIDE_EFFECTS__
|
|
961
985
|
*/
|
|
962
|
-
declare function useArrayJoin(list: MaybeRefOrGetter
|
|
986
|
+
declare function useArrayJoin(list: MaybeRefOrGetter<MaybeRefOrGetter<any>[]>, separator?: MaybeRefOrGetter<string>): UseArrayJoinReturn;
|
|
963
987
|
//#endregion
|
|
964
988
|
//#region useArrayMap/index.d.ts
|
|
965
989
|
type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
@@ -974,7 +998,7 @@ type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
|
974
998
|
*
|
|
975
999
|
* @__NO_SIDE_EFFECTS__
|
|
976
1000
|
*/
|
|
977
|
-
declare function useArrayMap<T, U = T>(list: MaybeRefOrGetter
|
|
1001
|
+
declare function useArrayMap<T, U = T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => U): UseArrayMapReturn<U>;
|
|
978
1002
|
//#endregion
|
|
979
1003
|
//#region useArrayReduce/index.d.ts
|
|
980
1004
|
type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValue: CV, currentIndex: number) => R;
|
|
@@ -989,7 +1013,7 @@ type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValue: CV, currentI
|
|
|
989
1013
|
*
|
|
990
1014
|
* @__NO_SIDE_EFFECTS__
|
|
991
1015
|
*/
|
|
992
|
-
declare function useArrayReduce<T>(list: MaybeRefOrGetter
|
|
1016
|
+
declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<T, T, T>): ComputedRef<T>;
|
|
993
1017
|
/**
|
|
994
1018
|
* Reactive `Array.reduce`
|
|
995
1019
|
*
|
|
@@ -1002,7 +1026,7 @@ declare function useArrayReduce<T>(list: MaybeRefOrGetter$1<MaybeRefOrGetter$1<T
|
|
|
1002
1026
|
*
|
|
1003
1027
|
* @__NO_SIDE_EFFECTS__
|
|
1004
1028
|
*/
|
|
1005
|
-
declare function useArrayReduce<T, U>(list: MaybeRefOrGetter
|
|
1029
|
+
declare function useArrayReduce<T, U>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<U, T, U>, initialValue: MaybeRefOrGetter<U>): ComputedRef<U>;
|
|
1006
1030
|
//#endregion
|
|
1007
1031
|
//#region useArraySome/index.d.ts
|
|
1008
1032
|
type UseArraySomeReturn = ComputedRef<boolean>;
|
|
@@ -1017,7 +1041,7 @@ type UseArraySomeReturn = ComputedRef<boolean>;
|
|
|
1017
1041
|
*
|
|
1018
1042
|
* @__NO_SIDE_EFFECTS__
|
|
1019
1043
|
*/
|
|
1020
|
-
declare function useArraySome<T>(list: MaybeRefOrGetter
|
|
1044
|
+
declare function useArraySome<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArraySomeReturn;
|
|
1021
1045
|
//#endregion
|
|
1022
1046
|
//#region useArrayUnique/index.d.ts
|
|
1023
1047
|
type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
@@ -1030,7 +1054,7 @@ type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
|
1030
1054
|
*
|
|
1031
1055
|
* @__NO_SIDE_EFFECTS__
|
|
1032
1056
|
*/
|
|
1033
|
-
declare function useArrayUnique<T>(list: MaybeRefOrGetter
|
|
1057
|
+
declare function useArrayUnique<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, compareFn?: (a: T, b: T, array: T[]) => boolean): UseArrayUniqueReturn<T>;
|
|
1034
1058
|
//#endregion
|
|
1035
1059
|
//#region useCounter/index.d.ts
|
|
1036
1060
|
interface UseCounterOptions {
|
|
@@ -1076,7 +1100,7 @@ interface UseCounterReturn {
|
|
|
1076
1100
|
* @param [initialValue]
|
|
1077
1101
|
* @param options
|
|
1078
1102
|
*/
|
|
1079
|
-
declare function useCounter(initialValue?: MaybeRef
|
|
1103
|
+
declare function useCounter(initialValue?: MaybeRef<number>, options?: UseCounterOptions): {
|
|
1080
1104
|
count: Readonly<Ref<number, number> | vue0.ShallowRef<number, number> | vue0.WritableComputedRef<number, number>>;
|
|
1081
1105
|
inc: (delta?: number) => number;
|
|
1082
1106
|
dec: (delta?: number) => number;
|
|
@@ -1093,7 +1117,7 @@ interface UseDateFormatOptions {
|
|
|
1093
1117
|
*
|
|
1094
1118
|
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument).
|
|
1095
1119
|
*/
|
|
1096
|
-
locales?: MaybeRefOrGetter
|
|
1120
|
+
locales?: MaybeRefOrGetter<Intl.LocalesArgument>;
|
|
1097
1121
|
/**
|
|
1098
1122
|
* A custom function to re-modify the way to display meridiem
|
|
1099
1123
|
*
|
|
@@ -1113,7 +1137,7 @@ type UseDateFormatReturn = ComputedRef<string>;
|
|
|
1113
1137
|
*
|
|
1114
1138
|
* @__NO_SIDE_EFFECTS__
|
|
1115
1139
|
*/
|
|
1116
|
-
declare function useDateFormat(date: MaybeRefOrGetter
|
|
1140
|
+
declare function useDateFormat(date: MaybeRefOrGetter<DateLike>, formatStr?: MaybeRefOrGetter<string>, options?: UseDateFormatOptions): UseDateFormatReturn;
|
|
1117
1141
|
//#endregion
|
|
1118
1142
|
//#region useDebounceFn/index.d.ts
|
|
1119
1143
|
type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
@@ -1129,7 +1153,7 @@ type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
|
1129
1153
|
*
|
|
1130
1154
|
* @__NO_SIDE_EFFECTS__
|
|
1131
1155
|
*/
|
|
1132
|
-
declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter
|
|
1156
|
+
declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T>;
|
|
1133
1157
|
//#endregion
|
|
1134
1158
|
//#region useInterval/index.d.ts
|
|
1135
1159
|
interface UseIntervalOptions<Controls extends boolean> {
|
|
@@ -1162,8 +1186,8 @@ type UseIntervalReturn = Readonly<ShallowRef<number>> | Readonly<UseIntervalCont
|
|
|
1162
1186
|
* @param interval
|
|
1163
1187
|
* @param options
|
|
1164
1188
|
*/
|
|
1165
|
-
declare function useInterval(interval?: MaybeRefOrGetter
|
|
1166
|
-
declare function useInterval(interval: MaybeRefOrGetter
|
|
1189
|
+
declare function useInterval(interval?: MaybeRefOrGetter<number>, options?: UseIntervalOptions<false>): Readonly<ShallowRef<number>>;
|
|
1190
|
+
declare function useInterval(interval: MaybeRefOrGetter<number>, options: UseIntervalOptions<true>): Readonly<UseIntervalControls & Pausable>;
|
|
1167
1191
|
//#endregion
|
|
1168
1192
|
//#region useIntervalFn/index.d.ts
|
|
1169
1193
|
interface UseIntervalFnOptions {
|
|
@@ -1189,7 +1213,7 @@ type UseIntervalFnReturn = Pausable;
|
|
|
1189
1213
|
* @param interval
|
|
1190
1214
|
* @param options
|
|
1191
1215
|
*/
|
|
1192
|
-
declare function useIntervalFn(cb: Fn$1, interval?: MaybeRefOrGetter
|
|
1216
|
+
declare function useIntervalFn(cb: Fn$1, interval?: MaybeRefOrGetter<number>, options?: UseIntervalFnOptions): UseIntervalFnReturn;
|
|
1193
1217
|
//#endregion
|
|
1194
1218
|
//#region useLastChanged/index.d.ts
|
|
1195
1219
|
interface UseLastChangedOptions<Immediate extends boolean, InitialValue extends number | null | undefined = undefined> extends WatchOptions<Immediate> {
|
|
@@ -1224,7 +1248,7 @@ declare function useLastChanged(source: WatchSource, options: UseLastChangedOpti
|
|
|
1224
1248
|
*
|
|
1225
1249
|
* @__NO_SIDE_EFFECTS__
|
|
1226
1250
|
*/
|
|
1227
|
-
declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter
|
|
1251
|
+
declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T>;
|
|
1228
1252
|
//#endregion
|
|
1229
1253
|
//#region useTimeoutFn/index.d.ts
|
|
1230
1254
|
interface UseTimeoutFnOptions {
|
|
@@ -1249,7 +1273,7 @@ type UseTimeoutFnReturn<CallbackFn extends AnyFn> = Stoppable<Parameters<Callbac
|
|
|
1249
1273
|
* @param interval
|
|
1250
1274
|
* @param options
|
|
1251
1275
|
*/
|
|
1252
|
-
declare function useTimeoutFn<CallbackFn extends AnyFn>(cb: CallbackFn, interval: MaybeRefOrGetter
|
|
1276
|
+
declare function useTimeoutFn<CallbackFn extends AnyFn>(cb: CallbackFn, interval: MaybeRefOrGetter<number>, options?: UseTimeoutFnOptions): UseTimeoutFnReturn<CallbackFn>;
|
|
1253
1277
|
//#endregion
|
|
1254
1278
|
//#region useTimeout/index.d.ts
|
|
1255
1279
|
interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
|
|
@@ -1274,8 +1298,8 @@ type UseTimoutReturn = ComputedRef<boolean> | {
|
|
|
1274
1298
|
* @param interval
|
|
1275
1299
|
* @param options
|
|
1276
1300
|
*/
|
|
1277
|
-
declare function useTimeout(interval?: MaybeRefOrGetter
|
|
1278
|
-
declare function useTimeout(interval: MaybeRefOrGetter
|
|
1301
|
+
declare function useTimeout(interval?: MaybeRefOrGetter<number>, options?: UseTimeoutOptions<false>): ComputedRef<boolean>;
|
|
1302
|
+
declare function useTimeout(interval: MaybeRefOrGetter<number>, options: UseTimeoutOptions<true>): {
|
|
1279
1303
|
ready: ComputedRef<boolean>;
|
|
1280
1304
|
} & Stoppable;
|
|
1281
1305
|
//#endregion
|
|
@@ -1306,7 +1330,7 @@ interface UseToNumberOptions {
|
|
|
1306
1330
|
*
|
|
1307
1331
|
* @__NO_SIDE_EFFECTS__
|
|
1308
1332
|
*/
|
|
1309
|
-
declare function useToNumber(value: MaybeRefOrGetter
|
|
1333
|
+
declare function useToNumber(value: MaybeRefOrGetter<number | string>, options?: UseToNumberOptions): ComputedRef<number>;
|
|
1310
1334
|
//#endregion
|
|
1311
1335
|
//#region useToString/index.d.ts
|
|
1312
1336
|
/**
|
|
@@ -1316,14 +1340,14 @@ declare function useToNumber(value: MaybeRefOrGetter$1<number | string>, options
|
|
|
1316
1340
|
*
|
|
1317
1341
|
* @__NO_SIDE_EFFECTS__
|
|
1318
1342
|
*/
|
|
1319
|
-
declare function useToString(value: MaybeRefOrGetter
|
|
1343
|
+
declare function useToString(value: MaybeRefOrGetter<unknown>): ComputedRef<string>;
|
|
1320
1344
|
//#endregion
|
|
1321
1345
|
//#region useToggle/index.d.ts
|
|
1322
1346
|
type ToggleFn = (value?: boolean) => void;
|
|
1323
1347
|
type UseToggleReturn = [ShallowRef<boolean>, ToggleFn] | ToggleFn;
|
|
1324
1348
|
interface UseToggleOptions<Truthy, Falsy> {
|
|
1325
|
-
truthyValue?: MaybeRefOrGetter
|
|
1326
|
-
falsyValue?: MaybeRefOrGetter
|
|
1349
|
+
truthyValue?: MaybeRefOrGetter<Truthy>;
|
|
1350
|
+
falsyValue?: MaybeRefOrGetter<Falsy>;
|
|
1327
1351
|
}
|
|
1328
1352
|
declare function useToggle<Truthy, Falsy, T = Truthy | Falsy>(initialValue: Ref<T>, options?: UseToggleOptions<Truthy, Falsy>): (value?: T) => T;
|
|
1329
1353
|
declare function useToggle<Truthy = true, Falsy = false, T = Truthy | Falsy>(initialValue?: T, options?: UseToggleOptions<Truthy, Falsy>): [ShallowRef<T>, (value?: T) => T];
|
|
@@ -1339,16 +1363,18 @@ declare function watchArray<T, Immediate extends Readonly<boolean> = false>(sour
|
|
|
1339
1363
|
//#endregion
|
|
1340
1364
|
//#region watchWithFilter/index.d.ts
|
|
1341
1365
|
interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {}
|
|
1342
|
-
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>):
|
|
1343
|
-
declare function watchWithFilter<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>):
|
|
1344
|
-
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>):
|
|
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;
|
|
1345
1369
|
//#endregion
|
|
1346
1370
|
//#region watchAtMost/index.d.ts
|
|
1347
1371
|
interface WatchAtMostOptions<Immediate> extends WatchWithFilterOptions<Immediate> {
|
|
1348
|
-
count: MaybeRefOrGetter
|
|
1372
|
+
count: MaybeRefOrGetter<number>;
|
|
1349
1373
|
}
|
|
1350
1374
|
interface WatchAtMostReturn {
|
|
1351
1375
|
stop: WatchStopHandle;
|
|
1376
|
+
pause: () => void;
|
|
1377
|
+
resume: () => void;
|
|
1352
1378
|
count: ShallowRef<number>;
|
|
1353
1379
|
}
|
|
1354
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;
|
|
@@ -1356,16 +1382,18 @@ declare function watchAtMost<T, Immediate extends Readonly<boolean> = false>(sou
|
|
|
1356
1382
|
//#endregion
|
|
1357
1383
|
//#region watchDebounced/index.d.ts
|
|
1358
1384
|
interface WatchDebouncedOptions<Immediate> extends WatchOptions<Immediate>, DebounceFilterOptions {
|
|
1359
|
-
debounce?: MaybeRefOrGetter
|
|
1385
|
+
debounce?: MaybeRefOrGetter<number>;
|
|
1360
1386
|
}
|
|
1361
|
-
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>):
|
|
1362
|
-
declare function watchDebounced<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchDebouncedOptions<Immediate>):
|
|
1363
|
-
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>):
|
|
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;
|
|
1390
|
+
/** @deprecated use `watchDebounced` instead */
|
|
1391
|
+
declare const debouncedWatch: typeof watchDebounced;
|
|
1364
1392
|
//#endregion
|
|
1365
1393
|
//#region watchDeep/index.d.ts
|
|
1366
|
-
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'>):
|
|
1367
|
-
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'>):
|
|
1368
|
-
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'>):
|
|
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;
|
|
1369
1397
|
//#endregion
|
|
1370
1398
|
//#region watchIgnorable/index.d.ts
|
|
1371
1399
|
type IgnoredUpdater = (updater: () => void) => void;
|
|
@@ -1378,35 +1406,44 @@ interface WatchIgnorableReturn {
|
|
|
1378
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;
|
|
1379
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;
|
|
1380
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;
|
|
1409
|
+
/** @deprecated use `watchIgnorable` instead */
|
|
1410
|
+
declare const ignorableWatch: typeof watchIgnorable;
|
|
1381
1411
|
//#endregion
|
|
1382
1412
|
//#region watchImmediate/index.d.ts
|
|
1383
|
-
declare function watchImmediate<T extends Readonly<WatchSource<unknown>[]>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'immediate'>):
|
|
1384
|
-
declare function watchImmediate<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>):
|
|
1385
|
-
declare function watchImmediate<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>):
|
|
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;
|
|
1386
1416
|
//#endregion
|
|
1387
1417
|
//#region watchOnce/index.d.ts
|
|
1388
|
-
declare function watchOnce<T extends Readonly<WatchSource<unknown>[]>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'once'>):
|
|
1389
|
-
declare function watchOnce<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>):
|
|
1390
|
-
declare function watchOnce<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>):
|
|
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;
|
|
1391
1421
|
//#endregion
|
|
1392
1422
|
//#region watchPausable/index.d.ts
|
|
1393
1423
|
interface WatchPausableReturn extends Pausable {
|
|
1394
1424
|
stop: WatchStopHandle;
|
|
1395
1425
|
}
|
|
1396
1426
|
type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
|
|
1427
|
+
/**
|
|
1428
|
+
* @deprecated This function will be removed in future version.
|
|
1429
|
+
*/
|
|
1397
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;
|
|
1398
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;
|
|
1399
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;
|
|
1433
|
+
/** @deprecated use `watchPausable` instead */
|
|
1434
|
+
declare const pausableWatch: typeof watchPausable;
|
|
1400
1435
|
//#endregion
|
|
1401
1436
|
//#region watchThrottled/index.d.ts
|
|
1402
1437
|
interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
|
|
1403
|
-
throttle?: MaybeRefOrGetter
|
|
1438
|
+
throttle?: MaybeRefOrGetter<number>;
|
|
1404
1439
|
trailing?: boolean;
|
|
1405
1440
|
leading?: boolean;
|
|
1406
1441
|
}
|
|
1407
|
-
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>):
|
|
1408
|
-
declare function watchThrottled<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchThrottledOptions<Immediate>):
|
|
1409
|
-
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>):
|
|
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;
|
|
1445
|
+
/** @deprecated use `watchThrottled` instead */
|
|
1446
|
+
declare const throttledWatch: typeof watchThrottled;
|
|
1410
1447
|
//#endregion
|
|
1411
1448
|
//#region watchTriggerable/index.d.ts
|
|
1412
1449
|
interface WatchTriggerableReturn<FnReturnT = void> extends WatchIgnorableReturn {
|
|
@@ -1437,4 +1474,4 @@ interface WheneverOptions extends WatchOptions {
|
|
|
1437
1474
|
*/
|
|
1438
1475
|
declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions): vue0.WatchHandle;
|
|
1439
1476
|
//#endregion
|
|
1440
|
-
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$1 as Fn, FunctionArgs, FunctionWrapperOptions, IfAny, IgnoredPrevAsyncUpdates, IgnoredUpdater, IsAny, IsDefinedReturn, MapOldSources, MapSources,
|
|
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$1 as 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 };
|