@reactive-vscode/vueuse 1.0.0-beta.2 → 1.0.1
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.cjs +3378 -2674
- package/dist/index.d.ts +234 -291
- package/dist/index.js +3380 -2814
- package/package.json +6 -6
package/dist/index.d.ts
CHANGED
|
@@ -33,9 +33,9 @@ export declare interface AfterFetchContext<T = any> {
|
|
|
33
33
|
*/
|
|
34
34
|
export declare type AnyFn = (...args: any[]) => any;
|
|
35
35
|
|
|
36
|
-
export declare type ArgumentsType<T
|
|
36
|
+
export declare type ArgumentsType<T> = T extends ((...args: infer U) => any) ? U : never;
|
|
37
37
|
|
|
38
|
-
export declare type Arrayable<T
|
|
38
|
+
export declare type Arrayable<T> = T[] | T;
|
|
39
39
|
|
|
40
40
|
export declare const assert: (condition: boolean, ...infos: any[]) => void;
|
|
41
41
|
|
|
@@ -49,7 +49,7 @@ export declare const asyncComputed: typeof computedAsync;
|
|
|
49
49
|
*/
|
|
50
50
|
export declare type AsyncComputedOnCancel = (cancelCallback: Fn) => void;
|
|
51
51
|
|
|
52
|
-
export declare interface AsyncComputedOptions<Lazy = boolean> {
|
|
52
|
+
export declare interface AsyncComputedOptions<Lazy = boolean> extends ConfigurableFlushSync {
|
|
53
53
|
/**
|
|
54
54
|
* Should value be evaluated lazily
|
|
55
55
|
*
|
|
@@ -66,15 +66,6 @@ export declare interface AsyncComputedOptions<Lazy = boolean> {
|
|
|
66
66
|
* @default true
|
|
67
67
|
*/
|
|
68
68
|
shallow?: boolean;
|
|
69
|
-
/**
|
|
70
|
-
* The flush option allows for greater control over the timing of a history point, default to `pre`
|
|
71
|
-
*
|
|
72
|
-
* Possible values: `pre`, `post`, `sync`
|
|
73
|
-
*
|
|
74
|
-
* It works in the same way as the flush option in watch and watch effect in vue reactivity
|
|
75
|
-
* @default 'sync'
|
|
76
|
-
*/
|
|
77
|
-
flush?: WatchOptionFlush;
|
|
78
69
|
/**
|
|
79
70
|
* Callback when error is caught.
|
|
80
71
|
*/
|
|
@@ -84,14 +75,14 @@ export declare interface AsyncComputedOptions<Lazy = boolean> {
|
|
|
84
75
|
/** @deprecated use `refAutoReset` instead */
|
|
85
76
|
export declare const autoResetRef: typeof refAutoReset;
|
|
86
77
|
|
|
87
|
-
export declare type Awaitable<T
|
|
78
|
+
export declare type Awaitable<T> = Promise<T> | T;
|
|
88
79
|
|
|
89
80
|
/**
|
|
90
81
|
* Compatible with versions below TypeScript 4.5 Awaited
|
|
91
82
|
*/
|
|
92
|
-
declare type Awaited_2<T
|
|
83
|
+
declare type Awaited_2<T> = T extends null | undefined ? T : T extends object & {
|
|
93
84
|
then: (onfulfilled: infer F, ...args: infer _) => any;
|
|
94
|
-
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited_2<V> : never : T
|
|
85
|
+
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited_2<V> : never : T;
|
|
95
86
|
export { Awaited_2 as Awaited }
|
|
96
87
|
|
|
97
88
|
export declare interface BeforeFetchContext {
|
|
@@ -126,7 +117,7 @@ declare interface BrowserLocationState {
|
|
|
126
117
|
|
|
127
118
|
export declare const bypassFilter: EventFilter;
|
|
128
119
|
|
|
129
|
-
declare type Callback<T
|
|
120
|
+
declare 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);
|
|
130
121
|
|
|
131
122
|
export declare const camelize: (str: string) => string;
|
|
132
123
|
|
|
@@ -167,11 +158,11 @@ export declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncCom
|
|
|
167
158
|
* @param options WatchOptionsBase
|
|
168
159
|
* @returns readonly shallowRef
|
|
169
160
|
*/
|
|
170
|
-
export declare function computedEager<T
|
|
161
|
+
export declare function computedEager<T>(fn: () => T, options?: ComputedEagerOptions): ComputedEagerReturn<T>;
|
|
171
162
|
|
|
172
163
|
export declare type ComputedEagerOptions = WatchOptionsBase;
|
|
173
164
|
|
|
174
|
-
export declare type ComputedEagerReturn<T
|
|
165
|
+
export declare type ComputedEagerReturn<T = any> = Readonly<ShallowRef<T>>;
|
|
175
166
|
|
|
176
167
|
declare type ComputedInjectGetter<T, K$1> = (source: T | undefined, oldValue?: K$1) => K$1;
|
|
177
168
|
|
|
@@ -179,13 +170,13 @@ declare type ComputedInjectGetterWithDefault<T, K$1> = (source: T, oldValue?: K$
|
|
|
179
170
|
|
|
180
171
|
declare type ComputedInjectSetter<T> = (v: T) => void;
|
|
181
172
|
|
|
182
|
-
export declare interface ComputedRefWithControl<T
|
|
173
|
+
export declare interface ComputedRefWithControl<T> extends ComputedRef<T>, ComputedWithControlRefExtra {}
|
|
183
174
|
|
|
184
|
-
export declare function computedWithControl<T
|
|
175
|
+
export declare function computedWithControl<T>(source: WatchSource | MultiWatchSources, fn: ComputedGetter<T>, options?: WatchOptions): ComputedRefWithControl<T>;
|
|
185
176
|
|
|
186
|
-
export declare function computedWithControl<T
|
|
177
|
+
export declare function computedWithControl<T>(source: WatchSource | MultiWatchSources, fn: WritableComputedOptions<T>, options?: WatchOptions): WritableComputedRefWithControl<T>;
|
|
187
178
|
|
|
188
|
-
export declare type ComputedWithControlRef<T
|
|
179
|
+
export declare type ComputedWithControlRef<T = any> = ComputedRefWithControl<T> | WritableComputedRefWithControl<T>;
|
|
189
180
|
|
|
190
181
|
export declare interface ComputedWithControlRefExtra {
|
|
191
182
|
/**
|
|
@@ -231,8 +222,11 @@ export declare interface ConfigurableFlushSync {
|
|
|
231
222
|
flush?: WatchOptionFlush;
|
|
232
223
|
}
|
|
233
224
|
|
|
234
|
-
declare interface
|
|
235
|
-
|
|
225
|
+
declare interface ConfigurableScheduler {
|
|
226
|
+
/**
|
|
227
|
+
* Custom scheduler to use for interval execution.
|
|
228
|
+
*/
|
|
229
|
+
scheduler?: (cb: Fn) => Pausable;
|
|
236
230
|
}
|
|
237
231
|
|
|
238
232
|
declare interface ConfigurableWindow {
|
|
@@ -247,19 +241,19 @@ export declare const controlledComputed: typeof computedWithControl;
|
|
|
247
241
|
/** @deprecated use `refWithControl` instead */
|
|
248
242
|
export declare const controlledRef: typeof refWithControl;
|
|
249
243
|
|
|
250
|
-
export declare interface ControlledRefOptions<T
|
|
244
|
+
export declare interface ControlledRefOptions<T> {
|
|
251
245
|
/**
|
|
252
246
|
* Callback function before the ref changing.
|
|
253
247
|
*
|
|
254
248
|
* Returning `false` to dismiss the change.
|
|
255
249
|
*/
|
|
256
|
-
onBeforeChange?: (value: T
|
|
250
|
+
onBeforeChange?: (value: T, oldValue: T) => void | boolean;
|
|
257
251
|
/**
|
|
258
252
|
* Callback function after the ref changed
|
|
259
253
|
*
|
|
260
254
|
* This happens synchronously, with less overhead compare to `watch`
|
|
261
255
|
*/
|
|
262
|
-
onChanged?: (value: T
|
|
256
|
+
onChanged?: (value: T, oldValue: T) => void;
|
|
263
257
|
}
|
|
264
258
|
|
|
265
259
|
/**
|
|
@@ -269,7 +263,7 @@ export declare interface ControlledRefOptions<T$1> {
|
|
|
269
263
|
*
|
|
270
264
|
* @__NO_SIDE_EFFECTS__
|
|
271
265
|
*/
|
|
272
|
-
export declare function createEventHook<T
|
|
266
|
+
export declare function createEventHook<T = any>(): EventHookReturn<T>;
|
|
273
267
|
|
|
274
268
|
export declare function createFetch(config?: CreateFetchOptions): typeof useFetch;
|
|
275
269
|
|
|
@@ -325,9 +319,9 @@ export declare const createReactiveFn: typeof reactify;
|
|
|
325
319
|
*
|
|
326
320
|
* @__NO_SIDE_EFFECTS__
|
|
327
321
|
*/
|
|
328
|
-
export declare function createRef<T
|
|
322
|
+
export declare function createRef<T = any, D extends boolean = false>(value: T, deep?: D): CreateRefReturn<T, D>;
|
|
329
323
|
|
|
330
|
-
export declare type CreateRefReturn<T
|
|
324
|
+
export declare type CreateRefReturn<T = any, D extends boolean = false> = ShallowOrDeepRef<T, D>;
|
|
331
325
|
|
|
332
326
|
/**
|
|
333
327
|
* Make a composable function usable with multiple Vue instances.
|
|
@@ -350,7 +344,7 @@ export declare function createSharedComposable<Fn$1 extends AnyFn>(composable: F
|
|
|
350
344
|
* await promise() // and be resolved together
|
|
351
345
|
* ```
|
|
352
346
|
*/
|
|
353
|
-
export declare function createSingletonPromise<T
|
|
347
|
+
export declare function createSingletonPromise<T>(fn: () => Promise<T>): SingletonPromiseReturn<T>;
|
|
354
348
|
|
|
355
349
|
/**
|
|
356
350
|
* Make a plain function accepting ref and raw values as arguments.
|
|
@@ -396,7 +390,7 @@ export declare interface DebounceFilterOptions {
|
|
|
396
390
|
* UnwrapRef<DeepMaybeRef<T>> === T
|
|
397
391
|
* ```
|
|
398
392
|
*/
|
|
399
|
-
export declare type DeepMaybeRef<T
|
|
393
|
+
export declare type DeepMaybeRef<T> = T extends Ref<infer V> ? MaybeRef<V> : T extends Array<any> | object ? { [K in keyof T]: DeepMaybeRef<T[K]> } : MaybeRef<T>;
|
|
400
394
|
|
|
401
395
|
declare type Direction = 'ltr' | 'rtl' | 'both';
|
|
402
396
|
|
|
@@ -406,7 +400,7 @@ export declare const eagerComputed: typeof computedEager;
|
|
|
406
400
|
/**
|
|
407
401
|
* Infers the element type of an array
|
|
408
402
|
*/
|
|
409
|
-
export declare type ElementOf<T
|
|
403
|
+
export declare type ElementOf<T> = T extends (infer E)[] ? E : never;
|
|
410
404
|
|
|
411
405
|
/**
|
|
412
406
|
* A = B
|
|
@@ -427,22 +421,22 @@ export declare type EventBusListener<T = unknown, P$1 = any> = (event: T, payloa
|
|
|
427
421
|
|
|
428
422
|
export declare type EventFilter<Args extends any[] = any[], This = any, Invoke extends AnyFn = AnyFn> = (invoke: Invoke, options: FunctionWrapperOptions<Args, This>) => ReturnType<Invoke> | Promisify<ReturnType<Invoke>>;
|
|
429
423
|
|
|
430
|
-
export declare interface EventHook<T
|
|
431
|
-
on: EventHookOn<T
|
|
432
|
-
off: EventHookOff<T
|
|
433
|
-
trigger: EventHookTrigger<T
|
|
424
|
+
export declare interface EventHook<T = any> {
|
|
425
|
+
on: EventHookOn<T>;
|
|
426
|
+
off: EventHookOff<T>;
|
|
427
|
+
trigger: EventHookTrigger<T>;
|
|
434
428
|
clear: () => void;
|
|
435
429
|
}
|
|
436
430
|
|
|
437
|
-
export declare type EventHookOff<T
|
|
431
|
+
export declare type EventHookOff<T = any> = (fn: Callback<T>) => void;
|
|
438
432
|
|
|
439
|
-
export declare type EventHookOn<T
|
|
433
|
+
export declare type EventHookOn<T = any> = (fn: Callback<T>) => {
|
|
440
434
|
off: () => void;
|
|
441
435
|
};
|
|
442
436
|
|
|
443
|
-
export declare type EventHookReturn<T
|
|
437
|
+
export declare type EventHookReturn<T> = EventHook<T>;
|
|
444
438
|
|
|
445
|
-
export declare type EventHookTrigger<T
|
|
439
|
+
export declare type EventHookTrigger<T = any> = (...param: Parameters<Callback<T>>) => Promise<unknown[]>;
|
|
446
440
|
|
|
447
441
|
/**
|
|
448
442
|
* Overload 1: Unwrap set to false
|
|
@@ -469,7 +463,7 @@ export declare interface ExtendRefOptions<Unwrap extends boolean = boolean> {
|
|
|
469
463
|
unwrap?: Unwrap;
|
|
470
464
|
}
|
|
471
465
|
|
|
472
|
-
export declare type ExtendRefReturn<T
|
|
466
|
+
export declare type ExtendRefReturn<T = any> = Ref<T>;
|
|
473
467
|
|
|
474
468
|
declare type Falsy = false | void | null | undefined | 0 | 0n | '';
|
|
475
469
|
|
|
@@ -530,17 +524,17 @@ export declare interface GeneralEventListener<E = Event> {
|
|
|
530
524
|
/**
|
|
531
525
|
* Shorthand for accessing `ref.value`
|
|
532
526
|
*/
|
|
533
|
-
export declare function get<T
|
|
527
|
+
export declare function get<T>(ref: MaybeRef<T>): T;
|
|
534
528
|
|
|
535
|
-
export declare function get<T
|
|
529
|
+
export declare function get<T, K$1 extends keyof T>(ref: MaybeRef<T>, key: K$1): T[K$1];
|
|
536
530
|
|
|
537
|
-
export declare const hasOwn: <T extends object, K extends keyof T>(val: T, key: K) => key is K;
|
|
531
|
+
export declare const hasOwn: <T extends object, K$1 extends keyof T>(val: T, key: K$1) => key is K$1;
|
|
538
532
|
|
|
539
533
|
export declare const hyphenate: (str: string) => string;
|
|
540
534
|
|
|
541
|
-
export declare function identity<T
|
|
535
|
+
export declare function identity<T>(arg: T): T;
|
|
542
536
|
|
|
543
|
-
export declare type IfAny<T
|
|
537
|
+
export declare type IfAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
|
|
544
538
|
|
|
545
539
|
/** @deprecated use `watchIgnorable` instead */
|
|
546
540
|
export declare const ignorableWatch: typeof watchIgnorable;
|
|
@@ -579,26 +573,26 @@ declare type IntersectButNotEqualType<D extends Direction, L, R$1> = D extends '
|
|
|
579
573
|
transform: Pick<Transform<L, R$1>, D>;
|
|
580
574
|
} : never;
|
|
581
575
|
|
|
582
|
-
export declare function invoke<T
|
|
576
|
+
export declare function invoke<T>(fn: () => T): T;
|
|
583
577
|
|
|
584
578
|
/**
|
|
585
579
|
* will return `true` if `T` is `any`, or `false` otherwise
|
|
586
580
|
*/
|
|
587
|
-
export declare type IsAny<T
|
|
581
|
+
export declare type IsAny<T> = IfAny<T, true, false>;
|
|
588
582
|
|
|
589
583
|
export declare const isDef: <T = any>(val?: T) => val is T;
|
|
590
584
|
|
|
591
|
-
export declare function isDefined<T
|
|
585
|
+
export declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
|
|
592
586
|
|
|
593
|
-
export declare function isDefined<T
|
|
587
|
+
export declare function isDefined<T>(v: Ref<T>): v is Ref<Exclude<T, null | undefined>>;
|
|
594
588
|
|
|
595
|
-
export declare function isDefined<T
|
|
589
|
+
export declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
|
|
596
590
|
|
|
597
591
|
export declare type IsDefinedReturn = boolean;
|
|
598
592
|
|
|
599
593
|
export declare const isObject: (val: any) => val is object;
|
|
600
594
|
|
|
601
|
-
export declare function makeDestructurable<T
|
|
595
|
+
export declare function makeDestructurable<T extends Record<string, unknown>, A$1 extends readonly any[]>(obj: T, arr: A$1): T & A$1;
|
|
602
596
|
|
|
603
597
|
/**
|
|
604
598
|
* Define the shape of a ref that supports manual reset functionality.
|
|
@@ -606,19 +600,19 @@ export declare function makeDestructurable<T$1 extends Record<string, unknown>,
|
|
|
606
600
|
* This interface extends the standard `Ref` type from Vue and adds a `reset` method.
|
|
607
601
|
* The `reset` method allows the ref to be manually reset to its default value.
|
|
608
602
|
*/
|
|
609
|
-
export declare interface ManualResetRefReturn<T
|
|
603
|
+
export declare interface ManualResetRefReturn<T> extends Ref<T> {
|
|
610
604
|
reset: Fn;
|
|
611
605
|
}
|
|
612
606
|
|
|
613
|
-
export declare type MapOldSources<T
|
|
607
|
+
export declare type MapOldSources<T, Immediate> = { [K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : never };
|
|
614
608
|
|
|
615
609
|
declare type MapQueueTask<T extends any[]> = { [K in keyof T]: UseAsyncQueueTask<T[K]> };
|
|
616
610
|
|
|
617
|
-
export declare type MapSources<T
|
|
611
|
+
export declare type MapSources<T> = { [K in keyof T]: T[K] extends WatchSource<infer V> ? V : never };
|
|
618
612
|
|
|
619
613
|
export { MultiWatchSources }
|
|
620
614
|
|
|
621
|
-
export declare type Mutable<T
|
|
615
|
+
export declare type Mutable<T> = { -readonly [P in keyof T]: T[P] };
|
|
622
616
|
|
|
623
617
|
export declare const noop: () => void;
|
|
624
618
|
|
|
@@ -635,17 +629,17 @@ export declare const notNullish: <T = any>(val?: T | null | undefined) => val is
|
|
|
635
629
|
|
|
636
630
|
export declare const now: () => number;
|
|
637
631
|
|
|
638
|
-
export declare function objectEntries<T
|
|
632
|
+
export declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
|
|
639
633
|
|
|
640
634
|
/**
|
|
641
635
|
* Create a new subset object by omit giving keys
|
|
642
636
|
*/
|
|
643
|
-
export declare function objectOmit<O extends object, T
|
|
637
|
+
export declare function objectOmit<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Omit<O, T>;
|
|
644
638
|
|
|
645
639
|
/**
|
|
646
640
|
* Create a new subset object by giving keys
|
|
647
641
|
*/
|
|
648
|
-
export declare function objectPick<O extends object, T
|
|
642
|
+
export declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
|
|
649
643
|
|
|
650
644
|
declare type OnCleanup = (cleanupFn: () => void) => void;
|
|
651
645
|
|
|
@@ -691,16 +685,16 @@ export declare interface PausableFilterOptions {
|
|
|
691
685
|
initialState?: 'active' | 'paused';
|
|
692
686
|
}
|
|
693
687
|
|
|
694
|
-
/** @deprecated
|
|
688
|
+
/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
|
|
695
689
|
export declare const pausableWatch: typeof watchPausable;
|
|
696
690
|
|
|
697
691
|
declare type PostMessage = typeof Worker.prototype['postMessage'];
|
|
698
692
|
|
|
699
693
|
export declare function promiseTimeout(ms: number, throwOnTimeout?: boolean, reason?: string): Promise<void>;
|
|
700
694
|
|
|
701
|
-
export declare type Promisify<T
|
|
695
|
+
export declare type Promisify<T> = Promise<Awaited_2<T>>;
|
|
702
696
|
|
|
703
|
-
export declare type PromisifyFn<T
|
|
697
|
+
export declare type PromisifyFn<T extends AnyFn> = (...args: ArgumentsType<T>) => Promisify<ReturnType<T>>;
|
|
704
698
|
|
|
705
699
|
/**
|
|
706
700
|
* Get a px value for SSR use, do not rely on this method outside of SSR as REM unit is assumed at 16px, which might not be the case on the client
|
|
@@ -709,7 +703,7 @@ export declare function pxValue(px: string): number;
|
|
|
709
703
|
|
|
710
704
|
export declare const rand: (min: number, max: number) => number;
|
|
711
705
|
|
|
712
|
-
export declare type Reactified<T
|
|
706
|
+
export declare 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;
|
|
713
707
|
|
|
714
708
|
/**
|
|
715
709
|
* Converts plain function into a reactive function.
|
|
@@ -721,20 +715,20 @@ export declare type Reactified<T$1, Computed extends boolean> = T$1 extends ((..
|
|
|
721
715
|
*
|
|
722
716
|
* @__NO_SIDE_EFFECTS__
|
|
723
717
|
*/
|
|
724
|
-
export declare function reactify<T
|
|
718
|
+
export declare function reactify<T extends AnyFn, K$1 extends boolean = true>(fn: T, options?: ReactifyOptions<K$1>): ReactifyReturn<T, K$1>;
|
|
725
719
|
|
|
726
|
-
export declare type ReactifyNested<T
|
|
720
|
+
export declare type ReactifyNested<T, Keys extends keyof T = keyof T, S$1 extends boolean = true> = { [K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S$1> : T[K] };
|
|
727
721
|
|
|
728
722
|
/**
|
|
729
723
|
* Apply `reactify` to an object
|
|
730
724
|
*
|
|
731
725
|
* @__NO_SIDE_EFFECTS__
|
|
732
726
|
*/
|
|
733
|
-
export declare function reactifyObject<T
|
|
727
|
+
export declare function reactifyObject<T extends object, Keys extends keyof T>(obj: T, keys?: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>;
|
|
734
728
|
|
|
735
|
-
export declare function reactifyObject<T
|
|
729
|
+
export declare function reactifyObject<T extends object, S$1 extends boolean = true>(obj: T, options?: ReactifyObjectOptions<S$1>): ReactifyObjectReturn<T, keyof T, S$1>;
|
|
736
730
|
|
|
737
|
-
export declare interface ReactifyObjectOptions<T
|
|
731
|
+
export declare interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
|
|
738
732
|
/**
|
|
739
733
|
* Includes names from Object.getOwnPropertyNames
|
|
740
734
|
*
|
|
@@ -743,46 +737,46 @@ export declare interface ReactifyObjectOptions<T$1 extends boolean> extends Reac
|
|
|
743
737
|
includeOwnProperties?: boolean;
|
|
744
738
|
}
|
|
745
739
|
|
|
746
|
-
export declare type ReactifyObjectReturn<T
|
|
740
|
+
export declare type ReactifyObjectReturn<T, Keys extends keyof T, S$1 extends boolean = true> = ReactifyNested<T, Keys, S$1>;
|
|
747
741
|
|
|
748
|
-
export declare interface ReactifyOptions<T
|
|
742
|
+
export declare interface ReactifyOptions<T extends boolean> {
|
|
749
743
|
/**
|
|
750
744
|
* Accept passing a function as a reactive getter
|
|
751
745
|
*
|
|
752
746
|
* @default true
|
|
753
747
|
*/
|
|
754
|
-
computedGetter?: T
|
|
748
|
+
computedGetter?: T;
|
|
755
749
|
}
|
|
756
750
|
|
|
757
|
-
export declare type ReactifyReturn<T
|
|
751
|
+
export declare type ReactifyReturn<T extends AnyFn = AnyFn, K$1 extends boolean = true> = Reactified<T, K$1>;
|
|
758
752
|
|
|
759
753
|
/**
|
|
760
754
|
* Computed reactive object.
|
|
761
755
|
*/
|
|
762
|
-
export declare function reactiveComputed<T
|
|
756
|
+
export declare function reactiveComputed<T extends object>(fn: ComputedGetter<T>): ReactiveComputedReturn<T>;
|
|
763
757
|
|
|
764
|
-
export declare type ReactiveComputedReturn<T
|
|
758
|
+
export declare type ReactiveComputedReturn<T extends object> = UnwrapNestedRefs<T>;
|
|
765
759
|
|
|
766
|
-
export declare function reactiveOmit<T
|
|
760
|
+
export declare function reactiveOmit<T extends object, K$1 extends keyof T>(obj: T, ...keys: (K$1 | K$1[])[]): ReactiveOmitReturn<T, K$1>;
|
|
767
761
|
|
|
768
|
-
export declare function reactiveOmit<T
|
|
762
|
+
export declare function reactiveOmit<T extends object>(obj: T, predicate: ReactiveOmitPredicate<T>): ReactiveOmitReturn<T>;
|
|
769
763
|
|
|
770
|
-
export declare type ReactiveOmitPredicate<T
|
|
764
|
+
export declare type ReactiveOmitPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
771
765
|
|
|
772
|
-
export declare type ReactiveOmitReturn<T
|
|
766
|
+
export declare type ReactiveOmitReturn<T extends object, K$1 extends keyof T | undefined = undefined> = [K$1] extends [undefined] ? Partial<T> : Omit<T, Extract<K$1, keyof T>>;
|
|
773
767
|
|
|
774
|
-
export declare function reactivePick<T
|
|
768
|
+
export declare function reactivePick<T extends object, K$1 extends keyof T>(obj: T, ...keys: (K$1 | K$1[])[]): ReactivePickReturn<T, K$1>;
|
|
775
769
|
|
|
776
|
-
export declare function reactivePick<T
|
|
770
|
+
export declare function reactivePick<T extends object>(obj: T, predicate: ReactivePickPredicate<T>): ReactivePickReturn<T, keyof T>;
|
|
777
771
|
|
|
778
|
-
export declare type ReactivePickPredicate<T
|
|
772
|
+
export declare type ReactivePickPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
779
773
|
|
|
780
|
-
export declare type ReactivePickReturn<T
|
|
774
|
+
export declare type ReactivePickReturn<T extends object, K$1 extends keyof T> = { [S in K$1]: UnwrapRef<T[S]> };
|
|
781
775
|
|
|
782
776
|
/**
|
|
783
777
|
* Maybe it's a computed ref, or a readonly value, or a getter function
|
|
784
778
|
*/
|
|
785
|
-
export declare type ReadonlyRefOrGetter<T
|
|
779
|
+
export declare type ReadonlyRefOrGetter<T> = ComputedRef<T> | (() => T);
|
|
786
780
|
|
|
787
781
|
/**
|
|
788
782
|
* Create a ref which will be reset to the default value after some time.
|
|
@@ -791,25 +785,25 @@ export declare type ReadonlyRefOrGetter<T$1> = ComputedRef<T$1> | (() => T$1);
|
|
|
791
785
|
* @param defaultValue The value which will be set.
|
|
792
786
|
* @param afterMs A zero-or-greater delay in milliseconds.
|
|
793
787
|
*/
|
|
794
|
-
export declare function refAutoReset<T
|
|
788
|
+
export declare function refAutoReset<T>(defaultValue: MaybeRefOrGetter<T>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T>;
|
|
795
789
|
|
|
796
|
-
export declare type RefAutoResetReturn<T
|
|
790
|
+
export declare type RefAutoResetReturn<T = any> = Ref<T>;
|
|
797
791
|
|
|
798
792
|
/**
|
|
799
793
|
* Debounce updates of a ref.
|
|
800
794
|
*
|
|
801
795
|
* @return A new debounced ref.
|
|
802
796
|
*/
|
|
803
|
-
export declare function refDebounced<T
|
|
797
|
+
export declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T>;
|
|
804
798
|
|
|
805
|
-
export declare type RefDebouncedReturn<T
|
|
799
|
+
export declare type RefDebouncedReturn<T = any> = Readonly<Ref<T>>;
|
|
806
800
|
|
|
807
801
|
/**
|
|
808
802
|
* Apply default value to a ref.
|
|
809
803
|
*
|
|
810
804
|
* @__NO_SIDE_EFFECTS__
|
|
811
805
|
*/
|
|
812
|
-
export declare function refDefault<T
|
|
806
|
+
export declare function refDefault<T>(source: Ref<T | undefined | null>, defaultValue: T): Ref<T>;
|
|
813
807
|
|
|
814
808
|
/**
|
|
815
809
|
* Create a ref with manual reset functionality.
|
|
@@ -817,7 +811,7 @@ export declare function refDefault<T$1>(source: Ref<T$1 | undefined | null>, def
|
|
|
817
811
|
* @see https://vueuse.org/refManualReset
|
|
818
812
|
* @param defaultValue The value which will be set.
|
|
819
813
|
*/
|
|
820
|
-
export declare function refManualReset<T
|
|
814
|
+
export declare function refManualReset<T>(defaultValue: MaybeRefOrGetter<T>): ManualResetRefReturn<T>;
|
|
821
815
|
|
|
822
816
|
/**
|
|
823
817
|
* Throttle execution of a function. Especially useful for rate limiting
|
|
@@ -828,28 +822,28 @@ export declare function refManualReset<T$1>(defaultValue: MaybeRefOrGetter<T$1>)
|
|
|
828
822
|
* @param trailing if true, update the value again after the delay time is up
|
|
829
823
|
* @param leading if true, update the value on the leading edge of the ms timeout
|
|
830
824
|
*/
|
|
831
|
-
export declare function refThrottled<T
|
|
825
|
+
export declare function refThrottled<T = any>(value: Ref<T>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T>;
|
|
832
826
|
|
|
833
|
-
export declare type RefThrottledReturn<T
|
|
827
|
+
export declare type RefThrottledReturn<T = any> = Ref<T>;
|
|
834
828
|
|
|
835
829
|
/**
|
|
836
830
|
* Fine-grained controls over ref and its reactivity.
|
|
837
831
|
*
|
|
838
832
|
* @__NO_SIDE_EFFECTS__
|
|
839
833
|
*/
|
|
840
|
-
export declare function refWithControl<T
|
|
841
|
-
get: (tracking?: boolean) => T
|
|
842
|
-
set: (value: T
|
|
843
|
-
untrackedGet: () => T
|
|
844
|
-
silentSet: (v: T
|
|
845
|
-
peek: () => T
|
|
846
|
-
lay: (v: T
|
|
847
|
-
}> & vue0.Ref<T
|
|
834
|
+
export declare function refWithControl<T>(initial: T, options?: ControlledRefOptions<T>): vue0.ShallowUnwrapRef<{
|
|
835
|
+
get: (tracking?: boolean) => T;
|
|
836
|
+
set: (value: T, triggering?: boolean) => void;
|
|
837
|
+
untrackedGet: () => T;
|
|
838
|
+
silentSet: (v: T) => void;
|
|
839
|
+
peek: () => T;
|
|
840
|
+
lay: (v: T) => void;
|
|
841
|
+
}> & vue0.Ref<T, T>;
|
|
848
842
|
|
|
849
843
|
/**
|
|
850
844
|
* A ref that allow to set null or undefined
|
|
851
845
|
*/
|
|
852
|
-
export declare type RemovableRef<T
|
|
846
|
+
export declare type RemovableRef<T> = Ref<T, T | null | undefined>;
|
|
853
847
|
|
|
854
848
|
export declare interface Serializer<T> {
|
|
855
849
|
read: (raw: string) => T;
|
|
@@ -861,18 +855,18 @@ export declare interface SerializerAsync<T> {
|
|
|
861
855
|
write: (value: T) => Awaitable<string>;
|
|
862
856
|
}
|
|
863
857
|
|
|
864
|
-
export declare function set<T
|
|
858
|
+
export declare function set<T>(ref: Ref<T>, value: T): void;
|
|
865
859
|
|
|
866
860
|
export declare function set<O extends object, K$1 extends keyof O>(target: O, key: K$1, value: O[K$1]): void;
|
|
867
861
|
|
|
868
|
-
export declare type ShallowOrDeepRef<T
|
|
862
|
+
export declare type ShallowOrDeepRef<T = any, D extends boolean = false> = D extends true ? Ref<T> : ShallowRef<T>;
|
|
869
863
|
|
|
870
|
-
export declare type ShallowUnwrapRef<T
|
|
864
|
+
export declare type ShallowUnwrapRef<T> = T extends Ref<infer P> ? P : T;
|
|
871
865
|
|
|
872
|
-
export declare type SharedComposableReturn<T
|
|
866
|
+
export declare type SharedComposableReturn<T extends AnyFn = AnyFn> = T;
|
|
873
867
|
|
|
874
|
-
export declare interface SingletonPromiseReturn<T
|
|
875
|
-
(): Promise<T
|
|
868
|
+
export declare interface SingletonPromiseReturn<T> {
|
|
869
|
+
(): Promise<T>;
|
|
876
870
|
/**
|
|
877
871
|
* Reset current staled promise.
|
|
878
872
|
* await it to have proper shutdown.
|
|
@@ -880,7 +874,7 @@ export declare interface SingletonPromiseReturn<T$1> {
|
|
|
880
874
|
reset: () => Promise<void>;
|
|
881
875
|
}
|
|
882
876
|
|
|
883
|
-
declare type SpecificFieldPartial<T
|
|
877
|
+
declare type SpecificFieldPartial<T, K$1 extends keyof T> = Partial<Pick<T, K$1>> & Omit<T, K$1>;
|
|
884
878
|
|
|
885
879
|
export declare interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
886
880
|
/**
|
|
@@ -907,6 +901,10 @@ declare type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direct
|
|
|
907
901
|
transform: SpecificFieldPartial<Transform<L, R$1>, IncludeType extends 'LR' ? 'ltr' : 'rtl'>;
|
|
908
902
|
} : D extends Exclude<Direction, 'both'> ? StrictIncludeMap<IncludeType, D, L, R$1> : never;
|
|
909
903
|
|
|
904
|
+
declare interface Supportable {
|
|
905
|
+
isSupported: ComputedRef<boolean>;
|
|
906
|
+
}
|
|
907
|
+
|
|
910
908
|
/**
|
|
911
909
|
* Two-way refs synchronization.
|
|
912
910
|
* From the set theory perspective to restrict the option's type
|
|
@@ -945,7 +943,7 @@ export declare type SyncRefOptions<L, R$1, D extends Direction> = ConfigurableFl
|
|
|
945
943
|
* @param source source ref
|
|
946
944
|
* @param targets
|
|
947
945
|
*/
|
|
948
|
-
export declare function syncRefs<T
|
|
946
|
+
export declare function syncRefs<T>(source: WatchSource<T>, targets: Ref<T> | Ref<T>[], options?: SyncRefsOptions): vue0.WatchHandle;
|
|
949
947
|
|
|
950
948
|
export declare interface SyncRefsOptions extends ConfigurableFlushSync {
|
|
951
949
|
/**
|
|
@@ -1001,9 +999,9 @@ export declare type TimerHandle = ReturnType<typeof setTimeout> | undefined;
|
|
|
1001
999
|
|
|
1002
1000
|
export declare const timestamp: () => number;
|
|
1003
1001
|
|
|
1004
|
-
export declare function toArray<T
|
|
1002
|
+
export declare function toArray<T>(value: T | readonly T[]): readonly T[];
|
|
1005
1003
|
|
|
1006
|
-
export declare function toArray<T
|
|
1004
|
+
export declare function toArray<T>(value: T | T[]): T[];
|
|
1007
1005
|
|
|
1008
1006
|
export declare interface ToDataURLOptions extends UseBase64Options {
|
|
1009
1007
|
/**
|
|
@@ -1024,22 +1022,22 @@ export declare type ToggleFn = (value?: boolean) => void;
|
|
|
1024
1022
|
* @see https://vueuse.org/toReactive
|
|
1025
1023
|
* @param objectRef A ref of object
|
|
1026
1024
|
*/
|
|
1027
|
-
export declare function toReactive<T
|
|
1025
|
+
export declare function toReactive<T extends object>(objectRef: MaybeRef<T>): UnwrapNestedRefs<T>;
|
|
1028
1026
|
|
|
1029
1027
|
/**
|
|
1030
1028
|
* Normalize value/ref/getter to `ref` or `computed`.
|
|
1031
1029
|
*/
|
|
1032
|
-
export declare function toRef<T
|
|
1030
|
+
export declare function toRef<T>(r: () => T): Readonly<Ref<T>>;
|
|
1033
1031
|
|
|
1034
|
-
export declare function toRef<T
|
|
1032
|
+
export declare function toRef<T>(r: ComputedRef<T>): ComputedRef<T>;
|
|
1035
1033
|
|
|
1036
|
-
export declare function toRef<T
|
|
1034
|
+
export declare function toRef<T>(r: MaybeRefOrGetter<T>): Ref<T>;
|
|
1037
1035
|
|
|
1038
|
-
export declare function toRef<T
|
|
1036
|
+
export declare function toRef<T>(r: T): Ref<T>;
|
|
1039
1037
|
|
|
1040
|
-
export declare function toRef<T
|
|
1038
|
+
export declare function toRef<T extends object, K$1 extends keyof T>(object: T, key: K$1): ToRef<T[K$1]>;
|
|
1041
1039
|
|
|
1042
|
-
export declare function toRef<T
|
|
1040
|
+
export declare function toRef<T extends object, K$1 extends keyof T>(object: T, key: K$1, defaultValue: T[K$1]): ToRef<Exclude<T[K$1], undefined>>;
|
|
1043
1041
|
|
|
1044
1042
|
/**
|
|
1045
1043
|
* Extended `toRefs` that also accepts refs of an object.
|
|
@@ -1048,7 +1046,7 @@ export declare function toRef<T$1 extends object, K$1 extends keyof T$1>(object:
|
|
|
1048
1046
|
* @param objectRef A ref or normal object or array.
|
|
1049
1047
|
* @param options Options
|
|
1050
1048
|
*/
|
|
1051
|
-
export declare function toRefs<T
|
|
1049
|
+
export declare function toRefs<T extends object>(objectRef: MaybeRef<T>, options?: ToRefsOptions): ToRefs<T>;
|
|
1052
1050
|
|
|
1053
1051
|
export declare interface ToRefsOptions {
|
|
1054
1052
|
/**
|
|
@@ -1081,22 +1079,22 @@ export declare type UnrefFn<T> = T extends ((...args: infer A) => infer R) ? (..
|
|
|
1081
1079
|
* alert('Counter is now larger than 7!')
|
|
1082
1080
|
* ```
|
|
1083
1081
|
*/
|
|
1084
|
-
export declare function until<T
|
|
1082
|
+
export declare function until<T extends unknown[]>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilArrayInstance<T>;
|
|
1085
1083
|
|
|
1086
|
-
export declare function until<T
|
|
1084
|
+
export declare function until<T>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilValueInstance<T>;
|
|
1087
1085
|
|
|
1088
|
-
export declare interface UntilArrayInstance<T
|
|
1089
|
-
readonly not: UntilArrayInstance<T
|
|
1090
|
-
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T
|
|
1086
|
+
export declare interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
1087
|
+
readonly not: UntilArrayInstance<T>;
|
|
1088
|
+
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T>>>, options?: UntilToMatchOptions) => Promise<T>;
|
|
1091
1089
|
}
|
|
1092
1090
|
|
|
1093
|
-
export declare interface UntilBaseInstance<T
|
|
1094
|
-
toMatch: (<U extends T
|
|
1095
|
-
changed: (options?: UntilToMatchOptions) => Promise<T
|
|
1096
|
-
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T
|
|
1091
|
+
export declare interface UntilBaseInstance<T, Not extends boolean = false> {
|
|
1092
|
+
toMatch: (<U$1 extends T = T>(condition: (v: T) => v is U$1, options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, U$1>> : Promise<U$1>) & ((condition: (v: T) => boolean, options?: UntilToMatchOptions) => Promise<T>);
|
|
1093
|
+
changed: (options?: UntilToMatchOptions) => Promise<T>;
|
|
1094
|
+
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T>;
|
|
1097
1095
|
}
|
|
1098
1096
|
|
|
1099
|
-
export declare interface UntilToMatchOptions {
|
|
1097
|
+
export declare interface UntilToMatchOptions extends ConfigurableFlushSync {
|
|
1100
1098
|
/**
|
|
1101
1099
|
* Milliseconds timeout for promise to resolve/reject if the when condition does not meet.
|
|
1102
1100
|
* 0 for never timed out
|
|
@@ -1110,12 +1108,6 @@ export declare interface UntilToMatchOptions {
|
|
|
1110
1108
|
* @default false
|
|
1111
1109
|
*/
|
|
1112
1110
|
throwOnTimeout?: boolean;
|
|
1113
|
-
/**
|
|
1114
|
-
* `flush` option for internal watch
|
|
1115
|
-
*
|
|
1116
|
-
* @default 'sync'
|
|
1117
|
-
*/
|
|
1118
|
-
flush?: WatchOptionFlush;
|
|
1119
1111
|
/**
|
|
1120
1112
|
* `deep` option for internal watch
|
|
1121
1113
|
*
|
|
@@ -1124,20 +1116,20 @@ export declare interface UntilToMatchOptions {
|
|
|
1124
1116
|
deep?: WatchOptions['deep'];
|
|
1125
1117
|
}
|
|
1126
1118
|
|
|
1127
|
-
export declare interface UntilValueInstance<T
|
|
1128
|
-
readonly not: UntilValueInstance<T
|
|
1129
|
-
toBe: <P = T
|
|
1130
|
-
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T
|
|
1131
|
-
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T
|
|
1132
|
-
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T
|
|
1133
|
-
toBeNaN: (options?: UntilToMatchOptions) => Promise<T
|
|
1119
|
+
export declare interface UntilValueInstance<T, Not extends boolean = false> extends UntilBaseInstance<T, Not> {
|
|
1120
|
+
readonly not: UntilValueInstance<T, Not extends true ? false : true>;
|
|
1121
|
+
toBe: <P$1 = T>(value: MaybeRefOrGetter<P$1>, options?: UntilToMatchOptions) => Not extends true ? Promise<T> : Promise<P$1>;
|
|
1122
|
+
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T & Falsy> : Promise<Exclude<T, Falsy>>;
|
|
1123
|
+
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, null>> : Promise<null>;
|
|
1124
|
+
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, undefined>> : Promise<undefined>;
|
|
1125
|
+
toBeNaN: (options?: UntilToMatchOptions) => Promise<T>;
|
|
1134
1126
|
}
|
|
1135
1127
|
|
|
1136
1128
|
export declare type UrlParams = Record<string, string[] | string>;
|
|
1137
1129
|
|
|
1138
|
-
export declare function useArrayDifference<T
|
|
1130
|
+
export declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, key?: keyof T, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
1139
1131
|
|
|
1140
|
-
export declare function useArrayDifference<T
|
|
1132
|
+
export declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, compareFn?: (value: T, othVal: T) => boolean, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
1141
1133
|
|
|
1142
1134
|
export declare interface UseArrayDifferenceOptions {
|
|
1143
1135
|
/**
|
|
@@ -1149,7 +1141,7 @@ export declare interface UseArrayDifferenceOptions {
|
|
|
1149
1141
|
symmetric?: boolean;
|
|
1150
1142
|
}
|
|
1151
1143
|
|
|
1152
|
-
export declare type UseArrayDifferenceReturn<T
|
|
1144
|
+
export declare type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;
|
|
1153
1145
|
|
|
1154
1146
|
/**
|
|
1155
1147
|
* Reactive `Array.every`
|
|
@@ -1162,7 +1154,7 @@ export declare type UseArrayDifferenceReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
|
1162
1154
|
*
|
|
1163
1155
|
* @__NO_SIDE_EFFECTS__
|
|
1164
1156
|
*/
|
|
1165
|
-
export declare function useArrayEvery<T
|
|
1157
|
+
export declare function useArrayEvery<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayEveryReturn;
|
|
1166
1158
|
|
|
1167
1159
|
export declare type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
1168
1160
|
|
|
@@ -1177,11 +1169,11 @@ export declare type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
|
1177
1169
|
*
|
|
1178
1170
|
* @__NO_SIDE_EFFECTS__
|
|
1179
1171
|
*/
|
|
1180
|
-
export declare function useArrayFilter<T
|
|
1172
|
+
export declare function useArrayFilter<T, S$1 extends T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => element is S$1): UseArrayFilterReturn<S$1>;
|
|
1181
1173
|
|
|
1182
|
-
export declare function useArrayFilter<T
|
|
1174
|
+
export declare function useArrayFilter<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => unknown): UseArrayFilterReturn<T>;
|
|
1183
1175
|
|
|
1184
|
-
export declare type UseArrayFilterReturn<T
|
|
1176
|
+
export declare type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
1185
1177
|
|
|
1186
1178
|
/**
|
|
1187
1179
|
* Reactive `Array.find`
|
|
@@ -1194,7 +1186,7 @@ export declare type UseArrayFilterReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
|
1194
1186
|
*
|
|
1195
1187
|
* @__NO_SIDE_EFFECTS__
|
|
1196
1188
|
*/
|
|
1197
|
-
export declare function useArrayFind<T
|
|
1189
|
+
export declare function useArrayFind<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindReturn<T>;
|
|
1198
1190
|
|
|
1199
1191
|
/**
|
|
1200
1192
|
* Reactive `Array.findIndex`
|
|
@@ -1207,7 +1199,7 @@ export declare function useArrayFind<T$1>(list: MaybeRefOrGetter<MaybeRefOrGette
|
|
|
1207
1199
|
*
|
|
1208
1200
|
* @__NO_SIDE_EFFECTS__
|
|
1209
1201
|
*/
|
|
1210
|
-
export declare function useArrayFindIndex<T
|
|
1202
|
+
export declare function useArrayFindIndex<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayFindIndexReturn;
|
|
1211
1203
|
|
|
1212
1204
|
export declare type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
1213
1205
|
|
|
@@ -1222,11 +1214,11 @@ export declare type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
|
1222
1214
|
*
|
|
1223
1215
|
* @__NO_SIDE_EFFECTS__
|
|
1224
1216
|
*/
|
|
1225
|
-
export declare function useArrayFindLast<T
|
|
1217
|
+
export declare function useArrayFindLast<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindLastReturn<T>;
|
|
1226
1218
|
|
|
1227
|
-
export declare type UseArrayFindLastReturn<T
|
|
1219
|
+
export declare type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
1228
1220
|
|
|
1229
|
-
export declare type UseArrayFindReturn<T
|
|
1221
|
+
export declare type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
1230
1222
|
|
|
1231
1223
|
/**
|
|
1232
1224
|
* Reactive `Array.includes`
|
|
@@ -1237,17 +1229,17 @@ export declare type UseArrayFindReturn<T$1 = any> = ComputedRef<T$1 | undefined>
|
|
|
1237
1229
|
*
|
|
1238
1230
|
* @__NO_SIDE_EFFECTS__
|
|
1239
1231
|
*/
|
|
1240
|
-
export declare function useArrayIncludes<T
|
|
1232
|
+
export declare function useArrayIncludes<T, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V$1>, comparator?: UseArrayIncludesComparatorFn<T, V$1>): UseArrayIncludesReturn;
|
|
1241
1233
|
|
|
1242
|
-
export declare function useArrayIncludes<T
|
|
1234
|
+
export declare function useArrayIncludes<T, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V$1>, comparator?: keyof T): UseArrayIncludesReturn;
|
|
1243
1235
|
|
|
1244
|
-
export declare function useArrayIncludes<T
|
|
1236
|
+
export declare function useArrayIncludes<T, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V$1>, options?: UseArrayIncludesOptions<T, V$1>): UseArrayIncludesReturn;
|
|
1245
1237
|
|
|
1246
|
-
export declare type UseArrayIncludesComparatorFn<T
|
|
1238
|
+
export declare type UseArrayIncludesComparatorFn<T, V$1> = ((element: T, value: V$1, index: number, array: MaybeRefOrGetter<T>[]) => boolean);
|
|
1247
1239
|
|
|
1248
|
-
export declare interface UseArrayIncludesOptions<T
|
|
1240
|
+
export declare interface UseArrayIncludesOptions<T, V$1> {
|
|
1249
1241
|
fromIndex?: number;
|
|
1250
|
-
comparator?: UseArrayIncludesComparatorFn<T
|
|
1242
|
+
comparator?: UseArrayIncludesComparatorFn<T, V$1> | keyof T;
|
|
1251
1243
|
}
|
|
1252
1244
|
|
|
1253
1245
|
export declare type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
@@ -1278,9 +1270,9 @@ export declare type UseArrayJoinReturn = ComputedRef<string>;
|
|
|
1278
1270
|
*
|
|
1279
1271
|
* @__NO_SIDE_EFFECTS__
|
|
1280
1272
|
*/
|
|
1281
|
-
export declare function useArrayMap<T
|
|
1273
|
+
export declare function useArrayMap<T, U$1 = T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => U$1): UseArrayMapReturn<U$1>;
|
|
1282
1274
|
|
|
1283
|
-
export declare type UseArrayMapReturn<T
|
|
1275
|
+
export declare type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
1284
1276
|
|
|
1285
1277
|
/**
|
|
1286
1278
|
* Reactive `Array.reduce`
|
|
@@ -1293,7 +1285,7 @@ export declare type UseArrayMapReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
|
1293
1285
|
*
|
|
1294
1286
|
* @__NO_SIDE_EFFECTS__
|
|
1295
1287
|
*/
|
|
1296
|
-
export declare function useArrayReduce<T
|
|
1288
|
+
export declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<T, T, T>): UseArrayReduceReturn<T>;
|
|
1297
1289
|
|
|
1298
1290
|
/**
|
|
1299
1291
|
* Reactive `Array.reduce`
|
|
@@ -1307,11 +1299,11 @@ export declare function useArrayReduce<T$1>(list: MaybeRefOrGetter<MaybeRefOrGet
|
|
|
1307
1299
|
*
|
|
1308
1300
|
* @__NO_SIDE_EFFECTS__
|
|
1309
1301
|
*/
|
|
1310
|
-
export declare function useArrayReduce<T
|
|
1302
|
+
export declare function useArrayReduce<T, U$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<U$1, T, U$1>, initialValue: MaybeRefOrGetter<U$1>): UseArrayReduceReturn<U$1>;
|
|
1311
1303
|
|
|
1312
1304
|
export declare type UseArrayReducer<PV, CV, R$1> = (previousValue: PV, currentValue: CV, currentIndex: number) => R$1;
|
|
1313
1305
|
|
|
1314
|
-
export declare type UseArrayReduceReturn<T
|
|
1306
|
+
export declare type UseArrayReduceReturn<T = any> = ComputedRef<T>;
|
|
1315
1307
|
|
|
1316
1308
|
/**
|
|
1317
1309
|
* Reactive `Array.some`
|
|
@@ -1324,7 +1316,7 @@ export declare type UseArrayReduceReturn<T$1 = any> = ComputedRef<T$1>;
|
|
|
1324
1316
|
*
|
|
1325
1317
|
* @__NO_SIDE_EFFECTS__
|
|
1326
1318
|
*/
|
|
1327
|
-
export declare function useArraySome<T
|
|
1319
|
+
export declare function useArraySome<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArraySomeReturn;
|
|
1328
1320
|
|
|
1329
1321
|
export declare type UseArraySomeReturn = ComputedRef<boolean>;
|
|
1330
1322
|
|
|
@@ -1337,9 +1329,9 @@ export declare type UseArraySomeReturn = ComputedRef<boolean>;
|
|
|
1337
1329
|
*
|
|
1338
1330
|
* @__NO_SIDE_EFFECTS__
|
|
1339
1331
|
*/
|
|
1340
|
-
export declare function useArrayUnique<T
|
|
1332
|
+
export declare function useArrayUnique<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, compareFn?: (a: T, b: T, array: T[]) => boolean): UseArrayUniqueReturn<T>;
|
|
1341
1333
|
|
|
1342
|
-
export declare type UseArrayUniqueReturn<T
|
|
1334
|
+
export declare type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
1343
1335
|
|
|
1344
1336
|
/**
|
|
1345
1337
|
* Asynchronous queue task controller.
|
|
@@ -1453,8 +1445,8 @@ export declare interface UseAsyncStateReturnBase<Data, Params extends any[], Sha
|
|
|
1453
1445
|
isReady: Ref<boolean>;
|
|
1454
1446
|
isLoading: Ref<boolean>;
|
|
1455
1447
|
error: Ref<unknown>;
|
|
1456
|
-
execute: (delay?: number, ...args: Params) => Promise<Data>;
|
|
1457
|
-
executeImmediate: (...args: Params) => Promise<Data>;
|
|
1448
|
+
execute: (delay?: number, ...args: Params) => Promise<Data | undefined>;
|
|
1449
|
+
executeImmediate: (...args: Params) => Promise<Data | undefined>;
|
|
1458
1450
|
}
|
|
1459
1451
|
|
|
1460
1452
|
export declare function useBase64(target: MaybeRefOrGetter<string | undefined>, options?: UseBase64Options): UseBase64Return;
|
|
@@ -1511,8 +1503,7 @@ export declare interface UseBroadcastChannelOptions extends ConfigurableWindow {
|
|
|
1511
1503
|
name: string;
|
|
1512
1504
|
}
|
|
1513
1505
|
|
|
1514
|
-
export declare interface UseBroadcastChannelReturn<D, P$1> {
|
|
1515
|
-
isSupported: ComputedRef<boolean>;
|
|
1506
|
+
export declare interface UseBroadcastChannelReturn<D, P$1> extends Supportable {
|
|
1516
1507
|
channel: Ref<BroadcastChannel | undefined>;
|
|
1517
1508
|
data: Ref<D>;
|
|
1518
1509
|
post: (data: P$1) => void;
|
|
@@ -1521,42 +1512,7 @@ export declare interface UseBroadcastChannelReturn<D, P$1> {
|
|
|
1521
1512
|
isClosed: ShallowRef<boolean>;
|
|
1522
1513
|
}
|
|
1523
1514
|
|
|
1524
|
-
|
|
1525
|
-
* Reactive browser location.
|
|
1526
|
-
*
|
|
1527
|
-
* @see https://vueuse.org/useBrowserLocation
|
|
1528
|
-
*
|
|
1529
|
-
* @__NO_SIDE_EFFECTS__
|
|
1530
|
-
*/
|
|
1531
|
-
declare function useBrowserLocation(options?: ConfigurableWindow): Ref<{
|
|
1532
|
-
readonly trigger: string;
|
|
1533
|
-
readonly state?: any;
|
|
1534
|
-
readonly length?: number | undefined;
|
|
1535
|
-
readonly origin?: string | undefined;
|
|
1536
|
-
hash?: string | undefined;
|
|
1537
|
-
host?: string | undefined;
|
|
1538
|
-
hostname?: string | undefined;
|
|
1539
|
-
href?: string | undefined;
|
|
1540
|
-
pathname?: string | undefined;
|
|
1541
|
-
port?: string | undefined;
|
|
1542
|
-
protocol?: string | undefined;
|
|
1543
|
-
search?: string | undefined;
|
|
1544
|
-
}, BrowserLocationState | {
|
|
1545
|
-
readonly trigger: string;
|
|
1546
|
-
readonly state?: any;
|
|
1547
|
-
readonly length?: number | undefined;
|
|
1548
|
-
readonly origin?: string | undefined;
|
|
1549
|
-
hash?: string | undefined;
|
|
1550
|
-
host?: string | undefined;
|
|
1551
|
-
hostname?: string | undefined;
|
|
1552
|
-
href?: string | undefined;
|
|
1553
|
-
pathname?: string | undefined;
|
|
1554
|
-
port?: string | undefined;
|
|
1555
|
-
protocol?: string | undefined;
|
|
1556
|
-
search?: string | undefined;
|
|
1557
|
-
}>;
|
|
1558
|
-
|
|
1559
|
-
export declare type UseBrowserLocationReturn = ReturnType<typeof useBrowserLocation>;
|
|
1515
|
+
export declare type UseBrowserLocationReturn = Ref<BrowserLocationState>;
|
|
1560
1516
|
|
|
1561
1517
|
export declare function useCached<T, D extends boolean = true>(refValue: Ref<T>, comparator?: (a: T, b: T) => boolean, options?: UseCachedOptions<D>): UseCachedReturn<T, D>;
|
|
1562
1518
|
|
|
@@ -1738,9 +1694,9 @@ export declare function useDebouncedRefHistory<Raw, Serialized = Raw>(source: Re
|
|
|
1738
1694
|
*
|
|
1739
1695
|
* @__NO_SIDE_EFFECTS__
|
|
1740
1696
|
*/
|
|
1741
|
-
export declare function useDebounceFn<T
|
|
1697
|
+
export declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T>;
|
|
1742
1698
|
|
|
1743
|
-
export declare type UseDebounceFnReturn<T
|
|
1699
|
+
export declare type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
1744
1700
|
|
|
1745
1701
|
export declare function useEventBus<T = unknown, P$1 = any>(key: EventBusIdentifier<T>): UseEventBusReturn<T, P$1>;
|
|
1746
1702
|
|
|
@@ -2116,7 +2072,7 @@ export declare function useNow(options: UseNowOptions<true>): {
|
|
|
2116
2072
|
now: Ref<Date>;
|
|
2117
2073
|
} & Pausable;
|
|
2118
2074
|
|
|
2119
|
-
export declare interface UseNowOptions<Controls extends boolean> {
|
|
2075
|
+
export declare interface UseNowOptions<Controls extends boolean> extends ConfigurableScheduler {
|
|
2120
2076
|
/**
|
|
2121
2077
|
* Expose more controls
|
|
2122
2078
|
*
|
|
@@ -2126,18 +2082,22 @@ export declare interface UseNowOptions<Controls extends boolean> {
|
|
|
2126
2082
|
/**
|
|
2127
2083
|
* Start the clock immediately
|
|
2128
2084
|
*
|
|
2085
|
+
* @deprecated Please use `scheduler` option instead
|
|
2129
2086
|
* @default true
|
|
2130
2087
|
*/
|
|
2131
2088
|
immediate?: boolean;
|
|
2132
2089
|
/**
|
|
2133
2090
|
* Update interval in milliseconds, or use requestAnimationFrame
|
|
2134
2091
|
*
|
|
2092
|
+
* @deprecated Please use `scheduler` option instead
|
|
2135
2093
|
* @default requestAnimationFrame
|
|
2136
2094
|
*/
|
|
2137
2095
|
interval?: 'requestAnimationFrame' | number;
|
|
2138
2096
|
}
|
|
2139
2097
|
|
|
2140
|
-
export declare type UseNowReturn =
|
|
2098
|
+
export declare type UseNowReturn<Controls extends boolean> = Controls extends true ? ({
|
|
2099
|
+
now: Ref<Date>;
|
|
2100
|
+
} & Pausable) : Ref<Date>;
|
|
2141
2101
|
|
|
2142
2102
|
/**
|
|
2143
2103
|
* Reactive URL representing an object.
|
|
@@ -2210,7 +2170,7 @@ export declare function usePrevious<T>(value: MaybeRefOrGetter<T>, initialValue:
|
|
|
2210
2170
|
*/
|
|
2211
2171
|
export declare function useRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseRefHistoryOptions<Raw, Serialized>): UseRefHistoryReturn<Raw, Serialized>;
|
|
2212
2172
|
|
|
2213
|
-
export declare interface UseRefHistoryOptions<Raw, Serialized = Raw> extends ConfigurableEventFilter {
|
|
2173
|
+
export declare interface UseRefHistoryOptions<Raw, Serialized = Raw> extends ConfigurableEventFilter, ConfigurableFlush {
|
|
2214
2174
|
/**
|
|
2215
2175
|
* Watch for deep changes, default to false
|
|
2216
2176
|
*
|
|
@@ -2219,15 +2179,6 @@ export declare interface UseRefHistoryOptions<Raw, Serialized = Raw> extends Con
|
|
|
2219
2179
|
* @default false
|
|
2220
2180
|
*/
|
|
2221
2181
|
deep?: boolean;
|
|
2222
|
-
/**
|
|
2223
|
-
* The flush option allows for greater control over the timing of a history point, default to 'pre'
|
|
2224
|
-
*
|
|
2225
|
-
* Possible values: 'pre', 'post', 'sync'
|
|
2226
|
-
* It works in the same way as the flush option in watch and watch effect in vue reactivity
|
|
2227
|
-
*
|
|
2228
|
-
* @default 'pre'
|
|
2229
|
-
*/
|
|
2230
|
-
flush?: WatchOptionFlush;
|
|
2231
2182
|
/**
|
|
2232
2183
|
* Maximum number of history to be kept. Default to unlimited.
|
|
2233
2184
|
*/
|
|
@@ -2288,20 +2239,6 @@ export declare interface UseRefHistoryReturn<Raw, Serialized> extends UseManualR
|
|
|
2288
2239
|
dispose: () => void;
|
|
2289
2240
|
}
|
|
2290
2241
|
|
|
2291
|
-
/**
|
|
2292
|
-
* Reactive Web Share API.
|
|
2293
|
-
*
|
|
2294
|
-
* @see https://vueuse.org/useShare
|
|
2295
|
-
* @param shareOptions
|
|
2296
|
-
* @param options
|
|
2297
|
-
*
|
|
2298
|
-
* @__NO_SIDE_EFFECTS__
|
|
2299
|
-
*/
|
|
2300
|
-
declare function useShare(shareOptions?: MaybeRefOrGetter<UseShareOptions>, options?: ConfigurableNavigator): {
|
|
2301
|
-
isSupported: vue0.ComputedRef<boolean>;
|
|
2302
|
-
share: (overrideOptions?: MaybeRefOrGetter<UseShareOptions>) => Promise<void>;
|
|
2303
|
-
};
|
|
2304
|
-
|
|
2305
2242
|
export declare interface UseShareOptions {
|
|
2306
2243
|
title?: string;
|
|
2307
2244
|
files?: File[];
|
|
@@ -2309,7 +2246,9 @@ export declare interface UseShareOptions {
|
|
|
2309
2246
|
url?: string;
|
|
2310
2247
|
}
|
|
2311
2248
|
|
|
2312
|
-
export declare
|
|
2249
|
+
export declare interface UseShareReturn extends Supportable {
|
|
2250
|
+
share: (overrideOptions?: MaybeRefOrGetter<UseShareOptions>) => Promise<void>;
|
|
2251
|
+
}
|
|
2313
2252
|
|
|
2314
2253
|
/**
|
|
2315
2254
|
* reactive sort array
|
|
@@ -2387,12 +2326,6 @@ export declare interface UseStepperReturn<StepName, Steps, Step> {
|
|
|
2387
2326
|
isAfter: (step: StepName) => boolean;
|
|
2388
2327
|
}
|
|
2389
2328
|
|
|
2390
|
-
declare function useTextareaAutosize(options?: UseTextareaAutosizeOptions): {
|
|
2391
|
-
textarea: vue0.Ref<HTMLTextAreaElement | null | undefined, HTMLTextAreaElement | null | undefined>;
|
|
2392
|
-
input: vue0.Ref<string, string>;
|
|
2393
|
-
triggerResize: () => void;
|
|
2394
|
-
};
|
|
2395
|
-
|
|
2396
2329
|
export declare interface UseTextareaAutosizeOptions extends ConfigurableWindow {
|
|
2397
2330
|
/** Textarea element to autosize. */
|
|
2398
2331
|
element?: MaybeRef<HTMLTextAreaElement | undefined | null>;
|
|
@@ -2408,7 +2341,11 @@ export declare interface UseTextareaAutosizeOptions extends ConfigurableWindow {
|
|
|
2408
2341
|
styleProp?: 'height' | 'minHeight';
|
|
2409
2342
|
}
|
|
2410
2343
|
|
|
2411
|
-
export declare
|
|
2344
|
+
export declare interface UseTextareaAutosizeReturn {
|
|
2345
|
+
textarea: Ref<HTMLTextAreaElement | undefined | null>;
|
|
2346
|
+
input: Ref<string>;
|
|
2347
|
+
triggerResize: () => void;
|
|
2348
|
+
}
|
|
2412
2349
|
|
|
2413
2350
|
/** @deprecated use `refThrottled` instead */
|
|
2414
2351
|
export declare const useThrottle: typeof refThrottled;
|
|
@@ -2448,7 +2385,7 @@ export declare type UseThrottledRefHistoryReturn<Raw, Serialized = Raw> = UseRef
|
|
|
2448
2385
|
*
|
|
2449
2386
|
* @__NO_SIDE_EFFECTS__
|
|
2450
2387
|
*/
|
|
2451
|
-
export declare function useThrottleFn<T
|
|
2388
|
+
export declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T>;
|
|
2452
2389
|
|
|
2453
2390
|
/**
|
|
2454
2391
|
* Reactive time ago formatter.
|
|
@@ -2472,7 +2409,7 @@ export declare interface UseTimeAgoMessagesBuiltIn {
|
|
|
2472
2409
|
invalid: string;
|
|
2473
2410
|
}
|
|
2474
2411
|
|
|
2475
|
-
export declare interface UseTimeAgoOptions<Controls extends boolean, UnitNames extends string = UseTimeAgoUnitNamesDefault> extends FormatTimeAgoOptions<UnitNames
|
|
2412
|
+
export declare interface UseTimeAgoOptions<Controls extends boolean, UnitNames extends string = UseTimeAgoUnitNamesDefault> extends FormatTimeAgoOptions<UnitNames>, ConfigurableScheduler {
|
|
2476
2413
|
/**
|
|
2477
2414
|
* Expose more controls
|
|
2478
2415
|
*
|
|
@@ -2482,6 +2419,7 @@ export declare interface UseTimeAgoOptions<Controls extends boolean, UnitNames e
|
|
|
2482
2419
|
/**
|
|
2483
2420
|
* Intervals to update, set 0 to disable auto update
|
|
2484
2421
|
*
|
|
2422
|
+
* @deprecated Please use `scheduler` option instead
|
|
2485
2423
|
* @default 30_000
|
|
2486
2424
|
*/
|
|
2487
2425
|
updateInterval?: number;
|
|
@@ -2569,7 +2507,7 @@ export declare function useTimestamp(options: UseTimestampOptions<true>): {
|
|
|
2569
2507
|
timestamp: ShallowRef<number>;
|
|
2570
2508
|
} & Pausable;
|
|
2571
2509
|
|
|
2572
|
-
export declare interface UseTimestampOptions<Controls extends boolean> {
|
|
2510
|
+
export declare interface UseTimestampOptions<Controls extends boolean> extends ConfigurableScheduler {
|
|
2573
2511
|
/**
|
|
2574
2512
|
* Expose more controls
|
|
2575
2513
|
*
|
|
@@ -2585,12 +2523,14 @@ export declare interface UseTimestampOptions<Controls extends boolean> {
|
|
|
2585
2523
|
/**
|
|
2586
2524
|
* Update the timestamp immediately
|
|
2587
2525
|
*
|
|
2526
|
+
* @deprecated Please use `scheduler` option instead
|
|
2588
2527
|
* @default true
|
|
2589
2528
|
*/
|
|
2590
2529
|
immediate?: boolean;
|
|
2591
2530
|
/**
|
|
2592
2531
|
* Update interval, or use requestAnimationFrame
|
|
2593
2532
|
*
|
|
2533
|
+
* @deprecated Please use `scheduler` option instead
|
|
2594
2534
|
* @default requestAnimationFrame
|
|
2595
2535
|
*/
|
|
2596
2536
|
interval?: 'requestAnimationFrame' | number;
|
|
@@ -2600,16 +2540,18 @@ export declare interface UseTimestampOptions<Controls extends boolean> {
|
|
|
2600
2540
|
callback?: (timestamp: number) => void;
|
|
2601
2541
|
}
|
|
2602
2542
|
|
|
2603
|
-
export declare type UseTimestampReturn =
|
|
2543
|
+
export declare type UseTimestampReturn<Controls extends boolean> = Controls extends true ? ({
|
|
2544
|
+
timestamp: ShallowRef<number>;
|
|
2545
|
+
} & Pausable) : ShallowRef<number>;
|
|
2604
2546
|
|
|
2605
2547
|
/**
|
|
2606
2548
|
* @deprecated use UseTimeoutReturn instead
|
|
2607
2549
|
*/
|
|
2608
2550
|
export declare type UseTimoutReturn = UseTimeoutReturn;
|
|
2609
2551
|
|
|
2610
|
-
export declare function useToggle<Truthy, Falsy$1, T
|
|
2552
|
+
export declare function useToggle<Truthy, Falsy$1, T = Truthy | Falsy$1>(initialValue: Ref<T>, options?: UseToggleOptions<Truthy, Falsy$1>): (value?: T) => T;
|
|
2611
2553
|
|
|
2612
|
-
export declare function useToggle<Truthy = true, Falsy$1 = false, T
|
|
2554
|
+
export declare function useToggle<Truthy = true, Falsy$1 = false, T = Truthy | Falsy$1>(initialValue?: T, options?: UseToggleOptions<Truthy, Falsy$1>): [ShallowRef<T>, (value?: T) => T];
|
|
2613
2555
|
|
|
2614
2556
|
export declare interface UseToggleOptions<Truthy, Falsy$1> {
|
|
2615
2557
|
truthyValue?: MaybeRefOrGetter<Truthy>;
|
|
@@ -2718,7 +2660,7 @@ export declare interface UseWebSocketOptions {
|
|
|
2718
2660
|
*
|
|
2719
2661
|
* @default false
|
|
2720
2662
|
*/
|
|
2721
|
-
heartbeat?: boolean | {
|
|
2663
|
+
heartbeat?: boolean | ConfigurableScheduler & {
|
|
2722
2664
|
/**
|
|
2723
2665
|
* Message for the heartbeat
|
|
2724
2666
|
*
|
|
@@ -2732,6 +2674,7 @@ export declare interface UseWebSocketOptions {
|
|
|
2732
2674
|
/**
|
|
2733
2675
|
* Interval, in milliseconds
|
|
2734
2676
|
*
|
|
2677
|
+
* @deprecated Please use `scheduler` option instead
|
|
2735
2678
|
* @default 1000
|
|
2736
2679
|
*/
|
|
2737
2680
|
interval?: number;
|
|
@@ -2835,13 +2778,13 @@ export declare interface UseWebSocketReturn<T> {
|
|
|
2835
2778
|
* @param fn
|
|
2836
2779
|
* @param options
|
|
2837
2780
|
*/
|
|
2838
|
-
export declare function useWebWorkerFn<T extends (...fnArgs: any[]) => any>(fn: T, options?: UseWebWorkerOptions):
|
|
2781
|
+
export declare function useWebWorkerFn<T extends (...fnArgs: any[]) => any>(fn: T, options?: UseWebWorkerOptions): UseWebWorkerFnReturn<T>;
|
|
2782
|
+
|
|
2783
|
+
export declare interface UseWebWorkerFnReturn<T extends (...fnArgs: any[]) => any> {
|
|
2839
2784
|
workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>;
|
|
2840
|
-
workerStatus:
|
|
2785
|
+
workerStatus: ShallowRef<WebWorkerStatus>;
|
|
2841
2786
|
workerTerminate: (status?: WebWorkerStatus) => void;
|
|
2842
|
-
}
|
|
2843
|
-
|
|
2844
|
-
export declare type UseWebWorkerFnReturn = ReturnType<typeof useWebWorkerFn>;
|
|
2787
|
+
}
|
|
2845
2788
|
|
|
2846
2789
|
export declare interface UseWebWorkerOptions extends ConfigurableWindow {
|
|
2847
2790
|
/**
|
|
@@ -2872,13 +2815,13 @@ export declare interface UseWebWorkerReturn<Data = any> {
|
|
|
2872
2815
|
*
|
|
2873
2816
|
* @see https://vueuse.org/watchArray
|
|
2874
2817
|
*/
|
|
2875
|
-
export declare function watchArray<T
|
|
2818
|
+
export 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;
|
|
2876
2819
|
|
|
2877
2820
|
export declare type WatchArrayCallback<V$1 = any, OV = any> = (value: V$1, oldValue: OV, added: V$1, removed: OV, onCleanup: (cleanupFn: () => void) => void) => any;
|
|
2878
2821
|
|
|
2879
|
-
export declare function watchAtMost<T
|
|
2822
|
+
export declare function watchAtMost<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
2880
2823
|
|
|
2881
|
-
export declare function watchAtMost<T
|
|
2824
|
+
export 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;
|
|
2882
2825
|
|
|
2883
2826
|
export declare interface WatchAtMostOptions<Immediate> extends WatchWithFilterOptions<Immediate> {
|
|
2884
2827
|
count: MaybeRefOrGetter<number>;
|
|
@@ -2891,27 +2834,27 @@ export declare interface WatchAtMostReturn {
|
|
|
2891
2834
|
count: ShallowRef<number>;
|
|
2892
2835
|
}
|
|
2893
2836
|
|
|
2894
|
-
export declare function watchDebounced<T
|
|
2837
|
+
export declare function watchDebounced<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
2895
2838
|
|
|
2896
|
-
export declare function watchDebounced<T
|
|
2839
|
+
export 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;
|
|
2897
2840
|
|
|
2898
|
-
export declare function watchDebounced<T
|
|
2841
|
+
export 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;
|
|
2899
2842
|
|
|
2900
2843
|
export declare interface WatchDebouncedOptions<Immediate> extends WatchOptions<Immediate>, DebounceFilterOptions {
|
|
2901
2844
|
debounce?: MaybeRefOrGetter<number>;
|
|
2902
2845
|
}
|
|
2903
2846
|
|
|
2904
|
-
export declare function watchDeep<T
|
|
2847
|
+
export declare function watchDeep<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
2905
2848
|
|
|
2906
|
-
export declare function watchDeep<T
|
|
2849
|
+
export 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;
|
|
2907
2850
|
|
|
2908
|
-
export declare function watchDeep<T
|
|
2851
|
+
export 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;
|
|
2909
2852
|
|
|
2910
|
-
export declare function watchIgnorable<T
|
|
2853
|
+
export declare function watchIgnorable<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
2911
2854
|
|
|
2912
|
-
export declare function watchIgnorable<T
|
|
2855
|
+
export 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;
|
|
2913
2856
|
|
|
2914
|
-
export declare function watchIgnorable<T
|
|
2857
|
+
export 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;
|
|
2915
2858
|
|
|
2916
2859
|
export declare interface WatchIgnorableReturn {
|
|
2917
2860
|
ignoreUpdates: IgnoredUpdater;
|
|
@@ -2919,28 +2862,28 @@ export declare interface WatchIgnorableReturn {
|
|
|
2919
2862
|
stop: WatchStopHandle;
|
|
2920
2863
|
}
|
|
2921
2864
|
|
|
2922
|
-
export declare function watchImmediate<T
|
|
2865
|
+
export declare function watchImmediate<T extends Readonly<MultiWatchSources>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2923
2866
|
|
|
2924
|
-
export declare function watchImmediate<T
|
|
2867
|
+
export declare function watchImmediate<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2925
2868
|
|
|
2926
|
-
export declare function watchImmediate<T
|
|
2869
|
+
export declare function watchImmediate<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2927
2870
|
|
|
2928
|
-
export declare function watchOnce<T
|
|
2871
|
+
export declare function watchOnce<T extends Readonly<MultiWatchSources>>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2929
2872
|
|
|
2930
|
-
export declare function watchOnce<T
|
|
2873
|
+
export declare function watchOnce<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2931
2874
|
|
|
2932
|
-
export declare function watchOnce<T
|
|
2875
|
+
export declare function watchOnce<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2933
2876
|
|
|
2934
2877
|
export declare type WatchOptionFlush = WatchOptions['flush'];
|
|
2935
2878
|
|
|
2936
|
-
/**
|
|
2937
|
-
|
|
2938
|
-
*/
|
|
2939
|
-
export declare function watchPausable<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
2879
|
+
/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
|
|
2880
|
+
export declare function watchPausable<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
2940
2881
|
|
|
2941
|
-
|
|
2882
|
+
/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
|
|
2883
|
+
export 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;
|
|
2942
2884
|
|
|
2943
|
-
|
|
2885
|
+
/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
|
|
2886
|
+
export 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;
|
|
2944
2887
|
|
|
2945
2888
|
export declare type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
|
|
2946
2889
|
|
|
@@ -2948,11 +2891,11 @@ export declare interface WatchPausableReturn extends Pausable {
|
|
|
2948
2891
|
stop: WatchStopHandle;
|
|
2949
2892
|
}
|
|
2950
2893
|
|
|
2951
|
-
export declare function watchThrottled<T
|
|
2894
|
+
export declare function watchThrottled<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
2952
2895
|
|
|
2953
|
-
export declare function watchThrottled<T
|
|
2896
|
+
export 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;
|
|
2954
2897
|
|
|
2955
|
-
export declare function watchThrottled<T
|
|
2898
|
+
export 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;
|
|
2956
2899
|
|
|
2957
2900
|
export declare interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
|
|
2958
2901
|
throttle?: MaybeRefOrGetter<number>;
|
|
@@ -2960,11 +2903,11 @@ export declare interface WatchThrottledOptions<Immediate> extends WatchOptions<I
|
|
|
2960
2903
|
leading?: boolean;
|
|
2961
2904
|
}
|
|
2962
2905
|
|
|
2963
|
-
export declare function watchTriggerable<T
|
|
2906
|
+
export declare function watchTriggerable<T extends Readonly<MultiWatchSources>, FnReturnT>(sources: [...T], cb: WatchTriggerableCallback<MapSources<T>, MapOldSources<T, true>, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2964
2907
|
|
|
2965
|
-
export declare function watchTriggerable<T
|
|
2908
|
+
export declare function watchTriggerable<T, FnReturnT>(source: WatchSource<T>, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2966
2909
|
|
|
2967
|
-
export declare function watchTriggerable<T
|
|
2910
|
+
export declare function watchTriggerable<T extends object, FnReturnT>(source: T, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2968
2911
|
|
|
2969
2912
|
export declare type WatchTriggerableCallback<V$1 = any, OV = any, R$1 = void> = (value: V$1, oldValue: OV, onCleanup: OnCleanup) => R$1;
|
|
2970
2913
|
|
|
@@ -2973,11 +2916,11 @@ export declare interface WatchTriggerableReturn<FnReturnT = void> extends WatchI
|
|
|
2973
2916
|
trigger: () => FnReturnT;
|
|
2974
2917
|
}
|
|
2975
2918
|
|
|
2976
|
-
export declare function watchWithFilter<T
|
|
2919
|
+
export declare function watchWithFilter<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
2977
2920
|
|
|
2978
|
-
export declare function watchWithFilter<T
|
|
2921
|
+
export 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;
|
|
2979
2922
|
|
|
2980
|
-
export declare function watchWithFilter<T
|
|
2923
|
+
export 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;
|
|
2981
2924
|
|
|
2982
2925
|
export declare interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {}
|
|
2983
2926
|
|
|
@@ -2992,7 +2935,7 @@ export declare type WebWorkerStatus = 'PENDING' | 'SUCCESS' | 'RUNNING' | 'ERROR
|
|
|
2992
2935
|
*
|
|
2993
2936
|
* @see https://vueuse.org/whenever
|
|
2994
2937
|
*/
|
|
2995
|
-
export declare function whenever<T
|
|
2938
|
+
export declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions): vue0.WatchHandle;
|
|
2996
2939
|
|
|
2997
2940
|
export declare interface WheneverOptions extends WatchOptions {
|
|
2998
2941
|
/**
|
|
@@ -3017,6 +2960,6 @@ export declare interface WritableComputedInjectOptionsWithDefault<T, K$1> {
|
|
|
3017
2960
|
set: ComputedInjectSetter<K$1>;
|
|
3018
2961
|
}
|
|
3019
2962
|
|
|
3020
|
-
export declare interface WritableComputedRefWithControl<T
|
|
2963
|
+
export declare interface WritableComputedRefWithControl<T> extends WritableComputedRef<T>, ComputedWithControlRefExtra {}
|
|
3021
2964
|
|
|
3022
2965
|
export { }
|