@reactive-vscode/vueuse 0.4.0 → 1.0.0-beta.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 +1164 -1596
- package/dist/index.d.ts +549 -342
- package/dist/index.js +1214 -1646
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
|
+
import { ComponentInternalInstance } from '@reactive-vscode/reactivity';
|
|
1
2
|
import { ComputedGetter } from '@reactive-vscode/reactivity';
|
|
2
3
|
import { ComputedRef } from '@reactive-vscode/reactivity';
|
|
4
|
+
import { getCurrentInstance } from '@reactive-vscode/reactivity';
|
|
5
|
+
import { inject } from '@reactive-vscode/reactivity';
|
|
6
|
+
import { InjectionKey } from '@reactive-vscode/reactivity';
|
|
3
7
|
import { MaybeRef } from '@reactive-vscode/reactivity';
|
|
4
8
|
import { MaybeRefOrGetter } from '@reactive-vscode/reactivity';
|
|
9
|
+
import { MultiWatchSources } from '@reactive-vscode/reactivity';
|
|
5
10
|
import { Ref } from '@reactive-vscode/reactivity';
|
|
6
11
|
import { ShallowRef } from '@reactive-vscode/reactivity';
|
|
7
12
|
import { ShallowUnwrapRef as ShallowUnwrapRef_2 } from '@reactive-vscode/reactivity';
|
|
8
13
|
import { ToRef } from '@reactive-vscode/reactivity';
|
|
9
14
|
import { ToRefs } from '@reactive-vscode/reactivity';
|
|
10
|
-
import { toValue as toValue_2 } from '@reactive-vscode/reactivity';
|
|
11
15
|
import { UnwrapNestedRefs } from '@reactive-vscode/reactivity';
|
|
12
16
|
import { UnwrapRef } from '@reactive-vscode/reactivity';
|
|
13
|
-
import * as
|
|
17
|
+
import * as vue0 from '@reactive-vscode/reactivity';
|
|
14
18
|
import { WatchCallback } from '@reactive-vscode/reactivity';
|
|
19
|
+
import { WatchHandle } from '@reactive-vscode/reactivity';
|
|
15
20
|
import { WatchOptions } from '@reactive-vscode/reactivity';
|
|
21
|
+
import { WatchOptionsBase } from '@reactive-vscode/reactivity';
|
|
16
22
|
import { WatchSource } from '@reactive-vscode/reactivity';
|
|
17
23
|
import { WatchStopHandle } from '@reactive-vscode/reactivity';
|
|
18
24
|
import { WritableComputedOptions } from '@reactive-vscode/reactivity';
|
|
@@ -30,12 +36,15 @@ export declare interface AfterFetchContext<T = any> {
|
|
|
30
36
|
*/
|
|
31
37
|
export declare type AnyFn = (...args: any[]) => any;
|
|
32
38
|
|
|
33
|
-
export declare type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
|
|
39
|
+
export declare type ArgumentsType<T$1> = T$1 extends ((...args: infer U) => any) ? U : never;
|
|
34
40
|
|
|
35
|
-
export declare type Arrayable<T> = T[] | T;
|
|
41
|
+
export declare type Arrayable<T$1> = T$1[] | T$1;
|
|
36
42
|
|
|
37
43
|
export declare const assert: (condition: boolean, ...infos: any[]) => void;
|
|
38
44
|
|
|
45
|
+
/** @deprecated use `computedAsync` instead */
|
|
46
|
+
export declare const asyncComputed: typeof computedAsync;
|
|
47
|
+
|
|
39
48
|
/**
|
|
40
49
|
* Handle overlapping async evaluations.
|
|
41
50
|
*
|
|
@@ -66,23 +75,26 @@ export declare interface AsyncComputedOptions<Lazy = boolean> {
|
|
|
66
75
|
* Possible values: `pre`, `post`, `sync`
|
|
67
76
|
*
|
|
68
77
|
* It works in the same way as the flush option in watch and watch effect in vue reactivity
|
|
69
|
-
* @default '
|
|
78
|
+
* @default 'sync'
|
|
70
79
|
*/
|
|
71
|
-
flush?:
|
|
80
|
+
flush?: WatchOptionFlush;
|
|
72
81
|
/**
|
|
73
82
|
* Callback when error is caught.
|
|
74
83
|
*/
|
|
75
84
|
onError?: (e: unknown) => void;
|
|
76
85
|
}
|
|
77
86
|
|
|
78
|
-
|
|
87
|
+
/** @deprecated use `refAutoReset` instead */
|
|
88
|
+
export declare const autoResetRef: typeof refAutoReset;
|
|
89
|
+
|
|
90
|
+
export declare type Awaitable<T$1> = Promise<T$1> | T$1;
|
|
79
91
|
|
|
80
92
|
/**
|
|
81
93
|
* Compatible with versions below TypeScript 4.5 Awaited
|
|
82
94
|
*/
|
|
83
|
-
declare type Awaited_2<T> = T extends null | undefined ? T : T extends object & {
|
|
95
|
+
declare type Awaited_2<T$1> = T$1 extends null | undefined ? T$1 : T$1 extends object & {
|
|
84
96
|
then: (onfulfilled: infer F, ...args: infer _) => any;
|
|
85
|
-
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited_2<V> : never : T;
|
|
97
|
+
} ? F extends ((value: infer V, ...args: infer _) => any) ? Awaited_2<V> : never : T$1;
|
|
86
98
|
export { Awaited_2 as Awaited }
|
|
87
99
|
|
|
88
100
|
export declare interface BeforeFetchContext {
|
|
@@ -117,14 +129,7 @@ declare interface BrowserLocationState {
|
|
|
117
129
|
|
|
118
130
|
export declare const bypassFilter: EventFilter;
|
|
119
131
|
|
|
120
|
-
|
|
121
|
-
* The source code for this function was inspired by vue-apollo's `useEventHook` util
|
|
122
|
-
* https://github.com/vuejs/vue-apollo/blob/v4/packages/vue-apollo-composable/src/util/useEventHook.ts
|
|
123
|
-
*/
|
|
124
|
-
|
|
125
|
-
declare type Callback<T> = IsAny<T> extends true ? (...param: any) => void : ([
|
|
126
|
-
T
|
|
127
|
-
] extends [void] ? (...param: unknown[]) => void : [T] extends [any[]] ? (...param: T) => void : (...param: [T, ...unknown[]]) => void);
|
|
132
|
+
declare type Callback<T$1> = IsAny<T$1> extends true ? (...param: any) => void : ([T$1] extends [void] ? (...param: unknown[]) => void : [T$1] extends [any[]] ? (...param: T$1) => void : (...param: [T$1, ...unknown[]]) => void);
|
|
128
133
|
|
|
129
134
|
export declare const camelize: (str: string) => string;
|
|
130
135
|
|
|
@@ -144,30 +149,46 @@ declare type Combination = 'overwrite' | 'chain';
|
|
|
144
149
|
* @param initialState The initial state, used until the first evaluation finishes
|
|
145
150
|
* @param optionsOrRef Additional options or a ref passed to receive the updates of the async evaluation
|
|
146
151
|
*/
|
|
147
|
-
declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: T, optionsOrRef: AsyncComputedOptions<true>): ComputedRef<T>;
|
|
152
|
+
export declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: T, optionsOrRef: AsyncComputedOptions<true>): ComputedRef<T>;
|
|
148
153
|
|
|
149
|
-
declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: undefined, optionsOrRef: AsyncComputedOptions<true>): ComputedRef<T | undefined>;
|
|
154
|
+
export declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: undefined, optionsOrRef: AsyncComputedOptions<true>): ComputedRef<T | undefined>;
|
|
150
155
|
|
|
151
|
-
declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: T, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T>;
|
|
156
|
+
export declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState: T, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T>;
|
|
152
157
|
|
|
153
|
-
declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState?: undefined, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T | undefined>;
|
|
154
|
-
export { computedAsync as asyncComputed }
|
|
155
|
-
export { computedAsync }
|
|
158
|
+
export declare function computedAsync<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState?: undefined, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T | undefined>;
|
|
156
159
|
|
|
157
|
-
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @deprecated This function will be removed in future version.
|
|
163
|
+
*
|
|
164
|
+
* Note: If you are using Vue 3.4+, you can straight use computed instead.
|
|
165
|
+
* Because in Vue 3.4+, if computed new value does not change,
|
|
166
|
+
* computed, effect, watch, watchEffect, render dependencies will not be triggered.
|
|
167
|
+
* refer: https://github.com/vuejs/core/pull/5912
|
|
168
|
+
*
|
|
169
|
+
* @param fn effect function
|
|
170
|
+
* @param options WatchOptionsBase
|
|
171
|
+
* @returns readonly shallowRef
|
|
172
|
+
*/
|
|
173
|
+
export declare function computedEager<T$1>(fn: () => T$1, options?: ComputedEagerOptions): ComputedEagerReturn<T$1>;
|
|
174
|
+
|
|
175
|
+
export declare type ComputedEagerOptions = WatchOptionsBase;
|
|
176
|
+
|
|
177
|
+
export declare type ComputedEagerReturn<T$1 = any> = Readonly<ShallowRef<T$1>>;
|
|
158
178
|
|
|
159
|
-
declare type
|
|
179
|
+
declare type ComputedInjectGetter<T, K$1> = (source: T | undefined, oldValue?: K$1) => K$1;
|
|
180
|
+
|
|
181
|
+
declare type ComputedInjectGetterWithDefault<T, K$1> = (source: T, oldValue?: K$1) => K$1;
|
|
160
182
|
|
|
161
183
|
declare type ComputedInjectSetter<T> = (v: T) => void;
|
|
162
184
|
|
|
163
|
-
export declare interface ComputedRefWithControl<T> extends ComputedRef<T>, ComputedWithControlRefExtra {
|
|
164
|
-
}
|
|
185
|
+
export declare interface ComputedRefWithControl<T$1> extends ComputedRef<T$1>, ComputedWithControlRefExtra {}
|
|
165
186
|
|
|
166
|
-
declare function computedWithControl<T
|
|
187
|
+
export declare function computedWithControl<T$1>(source: WatchSource | MultiWatchSources, fn: ComputedGetter<T$1>, options?: WatchOptions): ComputedRefWithControl<T$1>;
|
|
167
188
|
|
|
168
|
-
declare function computedWithControl<T
|
|
169
|
-
|
|
170
|
-
export
|
|
189
|
+
export declare function computedWithControl<T$1>(source: WatchSource | MultiWatchSources, fn: WritableComputedOptions<T$1>, options?: WatchOptions): WritableComputedRefWithControl<T$1>;
|
|
190
|
+
|
|
191
|
+
export declare type ComputedWithControlRef<T$1 = any> = ComputedRefWithControl<T$1> | WritableComputedRefWithControl<T$1>;
|
|
171
192
|
|
|
172
193
|
export declare interface ComputedWithControlRefExtra {
|
|
173
194
|
/**
|
|
@@ -200,7 +221,7 @@ export declare interface ConfigurableFlush {
|
|
|
200
221
|
*
|
|
201
222
|
* @default 'pre'
|
|
202
223
|
*/
|
|
203
|
-
flush?:
|
|
224
|
+
flush?: WatchOptionFlush;
|
|
204
225
|
}
|
|
205
226
|
|
|
206
227
|
export declare interface ConfigurableFlushSync {
|
|
@@ -210,7 +231,7 @@ export declare interface ConfigurableFlushSync {
|
|
|
210
231
|
*
|
|
211
232
|
* @default 'sync'
|
|
212
233
|
*/
|
|
213
|
-
flush?:
|
|
234
|
+
flush?: WatchOptionFlush;
|
|
214
235
|
}
|
|
215
236
|
|
|
216
237
|
declare interface ConfigurableNavigator {
|
|
@@ -223,24 +244,25 @@ declare interface ConfigurableWindow {
|
|
|
223
244
|
|
|
224
245
|
export declare function containsProp(obj: object, ...props: string[]): boolean;
|
|
225
246
|
|
|
226
|
-
/**
|
|
227
|
-
|
|
228
|
-
|
|
247
|
+
/** @deprecated use `computedWithControl` instead */
|
|
248
|
+
export declare const controlledComputed: typeof computedWithControl;
|
|
249
|
+
|
|
250
|
+
/** @deprecated use `refWithControl` instead */
|
|
229
251
|
export declare const controlledRef: typeof refWithControl;
|
|
230
252
|
|
|
231
|
-
export declare interface ControlledRefOptions<T> {
|
|
253
|
+
export declare interface ControlledRefOptions<T$1> {
|
|
232
254
|
/**
|
|
233
255
|
* Callback function before the ref changing.
|
|
234
256
|
*
|
|
235
257
|
* Returning `false` to dismiss the change.
|
|
236
258
|
*/
|
|
237
|
-
onBeforeChange?: (value: T, oldValue: T) => void | boolean;
|
|
259
|
+
onBeforeChange?: (value: T$1, oldValue: T$1) => void | boolean;
|
|
238
260
|
/**
|
|
239
261
|
* Callback function after the ref changed
|
|
240
262
|
*
|
|
241
263
|
* This happens synchronously, with less overhead compare to `watch`
|
|
242
264
|
*/
|
|
243
|
-
onChanged?: (value: T, oldValue: T) => void;
|
|
265
|
+
onChanged?: (value: T$1, oldValue: T$1) => void;
|
|
244
266
|
}
|
|
245
267
|
|
|
246
268
|
/**
|
|
@@ -250,7 +272,7 @@ export declare interface ControlledRefOptions<T> {
|
|
|
250
272
|
*
|
|
251
273
|
* @__NO_SIDE_EFFECTS__
|
|
252
274
|
*/
|
|
253
|
-
export declare function createEventHook<T = any>(): EventHookReturn<T>;
|
|
275
|
+
export declare function createEventHook<T$1 = any>(): EventHookReturn<T$1>;
|
|
254
276
|
|
|
255
277
|
export declare function createFetch(config?: CreateFetchOptions): typeof useFetch;
|
|
256
278
|
|
|
@@ -284,9 +306,66 @@ export declare interface CreateFetchOptions {
|
|
|
284
306
|
*
|
|
285
307
|
* @__NO_SIDE_EFFECTS__
|
|
286
308
|
*/
|
|
287
|
-
export declare function createGlobalState<Fn extends AnyFn>(stateFactory: Fn): CreateGlobalStateReturn<Fn>;
|
|
309
|
+
export declare function createGlobalState<Fn$1 extends AnyFn>(stateFactory: Fn$1): CreateGlobalStateReturn<Fn$1>;
|
|
310
|
+
|
|
311
|
+
export declare type CreateGlobalStateReturn<Fn$1 extends AnyFn = AnyFn> = Fn$1;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Create global state that can be injected into components.
|
|
315
|
+
*
|
|
316
|
+
* @see https://vueuse.org/createInjectionState
|
|
317
|
+
*
|
|
318
|
+
* @__NO_SIDE_EFFECTS__
|
|
319
|
+
*/
|
|
320
|
+
export declare function createInjectionState<Arguments extends Array<any>, Return>(composable: (...args: Arguments) => Return, options?: CreateInjectionStateOptions<Return>): CreateInjectionStateReturn<Arguments, Return>;
|
|
321
|
+
|
|
322
|
+
export declare interface CreateInjectionStateOptions<Return> {
|
|
323
|
+
/**
|
|
324
|
+
* Custom injectionKey for InjectionState
|
|
325
|
+
*/
|
|
326
|
+
injectionKey?: string | InjectionKey<Return>;
|
|
327
|
+
/**
|
|
328
|
+
* Default value for the InjectionState
|
|
329
|
+
*/
|
|
330
|
+
defaultValue?: Return;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export declare type CreateInjectionStateReturn<Arguments extends Array<any>, Return> = Readonly<[
|
|
334
|
+
/**
|
|
335
|
+
* Call this function in a provider component to create and provide the state.
|
|
336
|
+
*
|
|
337
|
+
* @param args Arguments passed to the composable
|
|
338
|
+
* @returns The state returned by the composable
|
|
339
|
+
*/
|
|
340
|
+
useProvidingState: (...args: Arguments) => Return,
|
|
341
|
+
/**
|
|
342
|
+
* Call this function in a consumer component to inject the state.
|
|
343
|
+
*
|
|
344
|
+
* @returns The injected state, or `undefined` if not provided and no default value was set.
|
|
345
|
+
*/
|
|
346
|
+
useInjectedState: () => Return | undefined]>;
|
|
347
|
+
|
|
348
|
+
/** @deprecated use `reactify` instead */
|
|
349
|
+
export declare const createReactiveFn: typeof reactify;
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* Returns a `deepRef` or `shallowRef` depending on the `deep` param.
|
|
353
|
+
*
|
|
354
|
+
* @example createRef(1) // ShallowRef<number>
|
|
355
|
+
* @example createRef(1, false) // ShallowRef<number>
|
|
356
|
+
* @example createRef(1, true) // Ref<number>
|
|
357
|
+
* @example createRef("string") // ShallowRef<string>
|
|
358
|
+
* @example createRef<"A"|"B">("A", true) // Ref<"A"|"B">
|
|
359
|
+
*
|
|
360
|
+
* @param value
|
|
361
|
+
* @param deep
|
|
362
|
+
* @returns the `deepRef` or `shallowRef`
|
|
363
|
+
*
|
|
364
|
+
* @__NO_SIDE_EFFECTS__
|
|
365
|
+
*/
|
|
366
|
+
export declare function createRef<T$1 = any, D extends boolean = false>(value: T$1, deep?: D): CreateRefReturn<T$1, D>;
|
|
288
367
|
|
|
289
|
-
declare type
|
|
368
|
+
export declare type CreateRefReturn<T$1 = any, D extends boolean = false> = ShallowOrDeepRef<T$1, D>;
|
|
290
369
|
|
|
291
370
|
/**
|
|
292
371
|
* Make a composable function usable with multiple Vue instances.
|
|
@@ -295,7 +374,7 @@ declare type CreateGlobalStateReturn<Fn extends AnyFn = AnyFn> = Fn;
|
|
|
295
374
|
*
|
|
296
375
|
* @__NO_SIDE_EFFECTS__
|
|
297
376
|
*/
|
|
298
|
-
export declare function createSharedComposable<Fn extends AnyFn>(composable: Fn): SharedComposableReturn<Fn>;
|
|
377
|
+
export declare function createSharedComposable<Fn$1 extends AnyFn>(composable: Fn$1): SharedComposableReturn<Fn$1>;
|
|
299
378
|
|
|
300
379
|
/**
|
|
301
380
|
* Create singleton promise function
|
|
@@ -309,7 +388,7 @@ export declare function createSharedComposable<Fn extends AnyFn>(composable: Fn)
|
|
|
309
388
|
* await promise() // and be resolved together
|
|
310
389
|
* ```
|
|
311
390
|
*/
|
|
312
|
-
export declare function createSingletonPromise<T>(fn: () => Promise<T>): SingletonPromiseReturn<T>;
|
|
391
|
+
export declare function createSingletonPromise<T$1>(fn: () => Promise<T$1>): SingletonPromiseReturn<T$1>;
|
|
313
392
|
|
|
314
393
|
/**
|
|
315
394
|
* Make a plain function accepting ref and raw values as arguments.
|
|
@@ -321,6 +400,12 @@ export declare function createUnrefFn<T extends Function>(fn: T): UnrefFn<T>;
|
|
|
321
400
|
|
|
322
401
|
export declare type DateLike = Date | number | string | undefined;
|
|
323
402
|
|
|
403
|
+
/** @deprecated use `refDebounced` instead */
|
|
404
|
+
export declare const debouncedRef: typeof refDebounced;
|
|
405
|
+
|
|
406
|
+
/** @deprecated use `watchDebounced` instead */
|
|
407
|
+
export declare const debouncedWatch: typeof watchDebounced;
|
|
408
|
+
|
|
324
409
|
/**
|
|
325
410
|
* Create an EventFilter that debounce the events
|
|
326
411
|
*/
|
|
@@ -349,63 +434,63 @@ export declare interface DebounceFilterOptions {
|
|
|
349
434
|
* UnwrapRef<DeepMaybeRef<T>> === T
|
|
350
435
|
* ```
|
|
351
436
|
*/
|
|
352
|
-
export declare type DeepMaybeRef<T> = T extends Ref<infer V> ? MaybeRef<V> : T extends Array<any> | object ? {
|
|
353
|
-
[K in keyof T]: DeepMaybeRef<T[K]>;
|
|
354
|
-
} : MaybeRef<T>;
|
|
437
|
+
export declare type DeepMaybeRef<T$1> = T$1 extends Ref<infer V> ? MaybeRef<V> : T$1 extends Array<any> | object ? { [K in keyof T$1]: DeepMaybeRef<T$1[K]> } : MaybeRef<T$1>;
|
|
355
438
|
|
|
356
439
|
declare type Direction = 'ltr' | 'rtl' | 'both';
|
|
357
440
|
|
|
441
|
+
/** @deprecated use `computedEager` instead */
|
|
442
|
+
export declare const eagerComputed: typeof computedEager;
|
|
443
|
+
|
|
358
444
|
/**
|
|
359
445
|
* Infers the element type of an array
|
|
360
446
|
*/
|
|
361
|
-
export declare type ElementOf<T> = T extends (infer E)[] ? E : never;
|
|
447
|
+
export declare type ElementOf<T$1> = T$1 extends (infer E)[] ? E : never;
|
|
362
448
|
|
|
363
449
|
/**
|
|
364
450
|
* A = B
|
|
365
451
|
*/
|
|
366
|
-
declare type Equal<A, B> = [A] extends [B] ? ([B] extends [A] ? true : false) : false;
|
|
452
|
+
declare type Equal<A$1, B> = [A$1] extends [B] ? ([B] extends [A$1] ? true : false) : false;
|
|
367
453
|
|
|
368
|
-
declare interface EqualType<D extends Direction, L, R, O extends keyof Transform<L, R> = D extends 'both' ? 'ltr' | 'rtl' : D> {
|
|
369
|
-
transform?: SpecificFieldPartial<Pick<Transform<L, R>, O>, O>;
|
|
454
|
+
declare interface EqualType<D extends Direction, L, R$1, O extends keyof Transform<L, R$1> = (D extends 'both' ? 'ltr' | 'rtl' : D)> {
|
|
455
|
+
transform?: SpecificFieldPartial<Pick<Transform<L, R$1>, O>, O>;
|
|
370
456
|
}
|
|
371
457
|
|
|
372
|
-
export declare type EventBusEvents<T, P = any> = Set<EventBusListener<T, P>>;
|
|
458
|
+
export declare type EventBusEvents<T, P$1 = any> = Set<EventBusListener<T, P$1>>;
|
|
373
459
|
|
|
374
460
|
export declare type EventBusIdentifier<T = unknown> = EventBusKey<T> | string | number;
|
|
375
461
|
|
|
376
|
-
export declare interface EventBusKey<T> extends Symbol {
|
|
377
|
-
}
|
|
462
|
+
export declare interface EventBusKey<T> extends Symbol {}
|
|
378
463
|
|
|
379
|
-
export declare type EventBusListener<T = unknown, P = any> = (event: T, payload?: P) => void;
|
|
464
|
+
export declare type EventBusListener<T = unknown, P$1 = any> = (event: T, payload?: P$1) => void;
|
|
380
465
|
|
|
381
466
|
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>>;
|
|
382
467
|
|
|
383
|
-
export declare interface EventHook<T = any> {
|
|
384
|
-
on: EventHookOn<T>;
|
|
385
|
-
off: EventHookOff<T>;
|
|
386
|
-
trigger: EventHookTrigger<T>;
|
|
468
|
+
export declare interface EventHook<T$1 = any> {
|
|
469
|
+
on: EventHookOn<T$1>;
|
|
470
|
+
off: EventHookOff<T$1>;
|
|
471
|
+
trigger: EventHookTrigger<T$1>;
|
|
387
472
|
clear: () => void;
|
|
388
473
|
}
|
|
389
474
|
|
|
390
|
-
export declare type EventHookOff<T = any> = (fn: Callback<T>) => void;
|
|
475
|
+
export declare type EventHookOff<T$1 = any> = (fn: Callback<T$1>) => void;
|
|
391
476
|
|
|
392
|
-
export declare type EventHookOn<T = any> = (fn: Callback<T>) => {
|
|
477
|
+
export declare type EventHookOn<T$1 = any> = (fn: Callback<T$1>) => {
|
|
393
478
|
off: () => void;
|
|
394
479
|
};
|
|
395
480
|
|
|
396
|
-
declare type EventHookReturn<T> = EventHook<T>;
|
|
481
|
+
export declare type EventHookReturn<T$1> = EventHook<T$1>;
|
|
397
482
|
|
|
398
|
-
export declare type EventHookTrigger<T = any> = (...param: Parameters<Callback<T>>) => Promise<unknown[]>;
|
|
483
|
+
export declare type EventHookTrigger<T$1 = any> = (...param: Parameters<Callback<T$1>>) => Promise<unknown[]>;
|
|
399
484
|
|
|
400
485
|
/**
|
|
401
486
|
* Overload 1: Unwrap set to false
|
|
402
487
|
*/
|
|
403
|
-
export declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R, extend: Extend, options?: Options): ShallowUnwrapRef_2<Extend> & R;
|
|
488
|
+
export declare function extendRef<R$1 extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R$1, extend: Extend, options?: Options): ShallowUnwrapRef_2<Extend> & R$1;
|
|
404
489
|
|
|
405
490
|
/**
|
|
406
491
|
* Overload 2: Unwrap unset or set to true
|
|
407
492
|
*/
|
|
408
|
-
export declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R, extend: Extend, options?: Options): Extend & R;
|
|
493
|
+
export declare function extendRef<R$1 extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R$1, extend: Extend, options?: Options): Extend & R$1;
|
|
409
494
|
|
|
410
495
|
export declare interface ExtendRefOptions<Unwrap extends boolean = boolean> {
|
|
411
496
|
/**
|
|
@@ -422,6 +507,8 @@ export declare interface ExtendRefOptions<Unwrap extends boolean = boolean> {
|
|
|
422
507
|
unwrap?: Unwrap;
|
|
423
508
|
}
|
|
424
509
|
|
|
510
|
+
export declare type ExtendRefReturn<T$1 = any> = Ref<T$1>;
|
|
511
|
+
|
|
425
512
|
declare type Falsy = false | void | null | undefined | 0 | 0n | '';
|
|
426
513
|
|
|
427
514
|
/**
|
|
@@ -466,7 +553,7 @@ export declare interface FormatTimeAgoOptions<UnitNames extends string = UseTime
|
|
|
466
553
|
units?: UseTimeAgoUnit<UnitNames>[];
|
|
467
554
|
}
|
|
468
555
|
|
|
469
|
-
export declare type FunctionArgs<Args extends any[] = any[], Return =
|
|
556
|
+
export declare type FunctionArgs<Args extends any[] = any[], Return = unknown> = (...args: Args) => Return;
|
|
470
557
|
|
|
471
558
|
export declare interface FunctionWrapperOptions<Args extends any[] = any[], This = any> {
|
|
472
559
|
fn: FunctionArgs<Args, This>;
|
|
@@ -481,28 +568,31 @@ export declare interface GeneralEventListener<E = Event> {
|
|
|
481
568
|
/**
|
|
482
569
|
* Shorthand for accessing `ref.value`
|
|
483
570
|
*/
|
|
484
|
-
export declare function get<T>(ref: MaybeRef<T>): T;
|
|
571
|
+
export declare function get<T$1>(ref: MaybeRef<T$1>): T$1;
|
|
485
572
|
|
|
486
|
-
export declare function get<T, K extends keyof T>(ref: MaybeRef<T>, key: K): T[K];
|
|
573
|
+
export declare function get<T$1, K$1 extends keyof T$1>(ref: MaybeRef<T$1>, key: K$1): T$1[K$1];
|
|
487
574
|
|
|
488
|
-
export declare function getLifeCycleTarget(target?:
|
|
575
|
+
export declare function getLifeCycleTarget(target?: ComponentInternalInstance | null): ComponentInternalInstance | null;
|
|
489
576
|
|
|
490
577
|
export declare const hasOwn: <T extends object, K extends keyof T>(val: T, key: K) => key is K;
|
|
491
578
|
|
|
492
579
|
export declare const hyphenate: (str: string) => string;
|
|
493
580
|
|
|
494
|
-
export declare function identity<T>(arg: T): T;
|
|
581
|
+
export declare function identity<T$1>(arg: T$1): T$1;
|
|
495
582
|
|
|
496
|
-
export declare type IfAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
|
|
583
|
+
export declare type IfAny<T$1, Y, N> = 0 extends (1 & T$1) ? Y : N;
|
|
497
584
|
|
|
498
|
-
|
|
585
|
+
/** @deprecated use `watchIgnorable` instead */
|
|
586
|
+
export declare const ignorableWatch: typeof watchIgnorable;
|
|
587
|
+
|
|
588
|
+
export declare type IgnoredPrevAsyncUpdates = () => void;
|
|
499
589
|
|
|
500
590
|
export declare type IgnoredUpdater = (updater: () => void) => void;
|
|
501
591
|
|
|
502
592
|
/**
|
|
503
593
|
* A ⊆ B
|
|
504
594
|
*/
|
|
505
|
-
declare type IncludeButNotEqual<A, B> = Equal<A, B> extends true ? false : A extends B ? true : false;
|
|
595
|
+
declare type IncludeButNotEqual<A$1, B> = Equal<A$1, B> extends true ? false : A$1 extends B ? true : false;
|
|
506
596
|
|
|
507
597
|
/**
|
|
508
598
|
* Increase string a value with unit
|
|
@@ -516,53 +606,74 @@ export declare function increaseWithUnit(target: string, delta: number): string;
|
|
|
516
606
|
|
|
517
607
|
export declare function increaseWithUnit(target: string | number, delta: number): string | number;
|
|
518
608
|
|
|
609
|
+
/**
|
|
610
|
+
* On the basis of `inject`, it is allowed to directly call inject to obtain the value after call provide in the same component.
|
|
611
|
+
*
|
|
612
|
+
* @example
|
|
613
|
+
* ```ts
|
|
614
|
+
* injectLocal('MyInjectionKey', 1)
|
|
615
|
+
* const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1
|
|
616
|
+
* ```
|
|
617
|
+
*
|
|
618
|
+
* @__NO_SIDE_EFFECTS__
|
|
619
|
+
*/
|
|
620
|
+
export declare const injectLocal: typeof inject;
|
|
621
|
+
|
|
622
|
+
export declare type InstanceProxy = NonNullable<NonNullable<ReturnType<typeof getCurrentInstance>>['proxy']>;
|
|
623
|
+
|
|
519
624
|
/**
|
|
520
625
|
* A ∩ B ≠ ∅
|
|
521
626
|
*/
|
|
522
|
-
declare type IntersectButNotEqual<A, B> = Equal<A, B> extends true ? false : A & B extends never ? false : true;
|
|
627
|
+
declare type IntersectButNotEqual<A$1, B> = Equal<A$1, B> extends true ? false : A$1 & B extends never ? false : true;
|
|
523
628
|
|
|
524
|
-
declare type IntersectButNotEqualType<D extends Direction, L, R> = D extends 'both' ? {
|
|
525
|
-
transform: Transform<L, R>;
|
|
629
|
+
declare type IntersectButNotEqualType<D extends Direction, L, R$1> = D extends 'both' ? {
|
|
630
|
+
transform: Transform<L, R$1>;
|
|
526
631
|
} : D extends Exclude<Direction, 'both'> ? {
|
|
527
|
-
transform: Pick<Transform<L, R>, D>;
|
|
632
|
+
transform: Pick<Transform<L, R$1>, D>;
|
|
528
633
|
} : never;
|
|
529
634
|
|
|
530
|
-
export declare function invoke<T>(fn: () => T): T;
|
|
635
|
+
export declare function invoke<T$1>(fn: () => T$1): T$1;
|
|
531
636
|
|
|
532
637
|
/**
|
|
533
638
|
* will return `true` if `T` is `any`, or `false` otherwise
|
|
534
639
|
*/
|
|
535
|
-
export declare type IsAny<T> = IfAny<T, true, false>;
|
|
640
|
+
export declare type IsAny<T$1> = IfAny<T$1, true, false>;
|
|
536
641
|
|
|
537
642
|
export declare const isDef: <T = any>(val?: T) => val is T;
|
|
538
643
|
|
|
539
|
-
export declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
|
|
644
|
+
export declare function isDefined<T$1>(v: ComputedRef<T$1>): v is ComputedRef<Exclude<T$1, null | undefined>>;
|
|
645
|
+
|
|
646
|
+
export declare function isDefined<T$1>(v: Ref<T$1>): v is Ref<Exclude<T$1, null | undefined>>;
|
|
540
647
|
|
|
541
|
-
export declare function isDefined<T>(v:
|
|
648
|
+
export declare function isDefined<T$1>(v: T$1): v is Exclude<T$1, null | undefined>;
|
|
542
649
|
|
|
543
|
-
export declare
|
|
650
|
+
export declare type IsDefinedReturn = boolean;
|
|
544
651
|
|
|
545
652
|
export declare const isObject: (val: any) => val is object;
|
|
546
653
|
|
|
547
|
-
|
|
654
|
+
declare type LocalProvidedKey<T$1> = InjectionKey<T$1> | string | number;
|
|
548
655
|
|
|
549
|
-
export declare
|
|
550
|
-
[K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : never;
|
|
551
|
-
};
|
|
656
|
+
export declare function makeDestructurable<T$1 extends Record<string, unknown>, A$1 extends readonly any[]>(obj: T$1, arr: A$1): T$1 & A$1;
|
|
552
657
|
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
658
|
+
/**
|
|
659
|
+
* Define the shape of a ref that supports manual reset functionality.
|
|
660
|
+
*
|
|
661
|
+
* This interface extends the standard `Ref` type from Vue and adds a `reset` method.
|
|
662
|
+
* The `reset` method allows the ref to be manually reset to its default value.
|
|
663
|
+
*/
|
|
664
|
+
export declare interface ManualResetRefReturn<T$1> extends Ref<T$1> {
|
|
665
|
+
reset: Fn;
|
|
666
|
+
}
|
|
556
667
|
|
|
557
|
-
export declare type
|
|
558
|
-
[K in keyof T]: T[K] extends WatchSource<infer V> ? V : never;
|
|
559
|
-
};
|
|
668
|
+
export declare type MapOldSources<T$1, Immediate> = { [K in keyof T$1]: T$1[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : never };
|
|
560
669
|
|
|
561
|
-
|
|
670
|
+
declare type MapQueueTask<T extends any[]> = { [K in keyof T]: UseAsyncQueueTask<T[K]> };
|
|
562
671
|
|
|
563
|
-
export declare type
|
|
564
|
-
|
|
565
|
-
}
|
|
672
|
+
export declare type MapSources<T$1> = { [K in keyof T$1]: T$1[K] extends WatchSource<infer V> ? V : never };
|
|
673
|
+
|
|
674
|
+
export { MultiWatchSources }
|
|
675
|
+
|
|
676
|
+
export declare type Mutable<T$1> = { -readonly [P in keyof T$1]: T$1[P] };
|
|
566
677
|
|
|
567
678
|
export declare const noop: () => void;
|
|
568
679
|
|
|
@@ -571,25 +682,25 @@ export declare function normalizeDate(date: DateLike): Date;
|
|
|
571
682
|
/**
|
|
572
683
|
* A ∩ B = ∅
|
|
573
684
|
*/
|
|
574
|
-
declare type NotIntersect<A, B> = Equal<A, B> extends true ? false : A & B extends never ? true : false;
|
|
685
|
+
declare type NotIntersect<A$1, B> = Equal<A$1, B> extends true ? false : A$1 & B extends never ? true : false;
|
|
575
686
|
|
|
576
|
-
declare type NotIntersectType<D extends Direction, L, R> = IntersectButNotEqualType<D, L, R>;
|
|
687
|
+
declare type NotIntersectType<D extends Direction, L, R$1> = IntersectButNotEqualType<D, L, R$1>;
|
|
577
688
|
|
|
578
689
|
export declare const notNullish: <T = any>(val?: T | null | undefined) => val is T;
|
|
579
690
|
|
|
580
691
|
export declare const now: () => number;
|
|
581
692
|
|
|
582
|
-
export declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
|
|
693
|
+
export declare function objectEntries<T$1 extends object>(obj: T$1): Array<[keyof T$1, T$1[keyof T$1]]>;
|
|
583
694
|
|
|
584
695
|
/**
|
|
585
696
|
* Create a new subset object by omit giving keys
|
|
586
697
|
*/
|
|
587
|
-
export declare function objectOmit<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Omit<O, T>;
|
|
698
|
+
export declare function objectOmit<O extends object, T$1 extends keyof O>(obj: O, keys: T$1[], omitUndefined?: boolean): Omit<O, T$1>;
|
|
588
699
|
|
|
589
700
|
/**
|
|
590
701
|
* Create a new subset object by giving keys
|
|
591
702
|
*/
|
|
592
|
-
export declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
|
|
703
|
+
export declare function objectPick<O extends object, T$1 extends keyof O>(obj: O, keys: T$1[], omitUndefined?: boolean): Pick<O, T$1>;
|
|
593
704
|
|
|
594
705
|
declare type OnCleanup = (cleanupFn: () => void) => void;
|
|
595
706
|
|
|
@@ -626,7 +737,7 @@ export declare function pausableFilter(extendFilter?: EventFilter, options?: Pau
|
|
|
626
737
|
eventFilter: EventFilter;
|
|
627
738
|
};
|
|
628
739
|
|
|
629
|
-
declare interface PausableFilterOptions {
|
|
740
|
+
export declare interface PausableFilterOptions {
|
|
630
741
|
/**
|
|
631
742
|
* The initial state
|
|
632
743
|
*
|
|
@@ -635,19 +746,38 @@ declare interface PausableFilterOptions {
|
|
|
635
746
|
initialState?: 'active' | 'paused';
|
|
636
747
|
}
|
|
637
748
|
|
|
749
|
+
/** @deprecated use `watchPausable` instead */
|
|
750
|
+
export declare const pausableWatch: typeof watchPausable;
|
|
751
|
+
|
|
638
752
|
declare type PostMessage = typeof Worker.prototype['postMessage'];
|
|
639
753
|
|
|
640
754
|
export declare function promiseTimeout(ms: number, throwOnTimeout?: boolean, reason?: string): Promise<void>;
|
|
641
755
|
|
|
642
|
-
export declare type Promisify<T> = Promise<Awaited_2<T>>;
|
|
756
|
+
export declare type Promisify<T$1> = Promise<Awaited_2<T$1>>;
|
|
757
|
+
|
|
758
|
+
export declare type PromisifyFn<T$1 extends AnyFn> = (...args: ArgumentsType<T$1>) => Promisify<ReturnType<T$1>>;
|
|
759
|
+
|
|
760
|
+
/**
|
|
761
|
+
* On the basis of `provide`, it is allowed to directly call inject to obtain the value after call provide in the same component.
|
|
762
|
+
*
|
|
763
|
+
* @example
|
|
764
|
+
* ```ts
|
|
765
|
+
* provideLocal('MyInjectionKey', 1)
|
|
766
|
+
* const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1
|
|
767
|
+
* ```
|
|
768
|
+
*/
|
|
769
|
+
export declare function provideLocal<T$1, K$1 = LocalProvidedKey<T$1>>(key: K$1, value: K$1 extends InjectionKey<infer V> ? V : T$1): ProvideLocalReturn;
|
|
643
770
|
|
|
644
|
-
export declare type
|
|
771
|
+
export declare type ProvideLocalReturn = void;
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* 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
|
|
775
|
+
*/
|
|
776
|
+
export declare function pxValue(px: string): number;
|
|
645
777
|
|
|
646
778
|
export declare const rand: (min: number, max: number) => number;
|
|
647
779
|
|
|
648
|
-
export declare type Reactified<T, Computed extends boolean> = T extends (...args: infer A) => infer R ? (...args: {
|
|
649
|
-
[K in keyof A]: Computed extends true ? MaybeRefOrGetter<A[K]> : MaybeRef<A[K]>;
|
|
650
|
-
}) => ComputedRef<R> : never;
|
|
780
|
+
export declare type Reactified<T$1, Computed extends boolean> = T$1 extends ((...args: infer A) => infer R) ? (...args: { [K in keyof A]: Computed extends true ? MaybeRefOrGetter<A[K]> : MaybeRef<A[K]> }) => ComputedRef<R> : never;
|
|
651
781
|
|
|
652
782
|
/**
|
|
653
783
|
* Converts plain function into a reactive function.
|
|
@@ -659,24 +789,20 @@ export declare type Reactified<T, Computed extends boolean> = T extends (...args
|
|
|
659
789
|
*
|
|
660
790
|
* @__NO_SIDE_EFFECTS__
|
|
661
791
|
*/
|
|
662
|
-
declare function reactify<T extends AnyFn, K extends boolean = true>(fn: T, options?: ReactifyOptions<K>): ReactifyReturn<T, K>;
|
|
663
|
-
export { reactify as createReactiveFn }
|
|
664
|
-
export { reactify }
|
|
792
|
+
export declare function reactify<T$1 extends AnyFn, K$1 extends boolean = true>(fn: T$1, options?: ReactifyOptions<K$1>): ReactifyReturn<T$1, K$1>;
|
|
665
793
|
|
|
666
|
-
export declare type ReactifyNested<T, Keys extends keyof T = keyof T, S extends boolean = true> = {
|
|
667
|
-
[K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S> : T[K];
|
|
668
|
-
};
|
|
794
|
+
export declare type ReactifyNested<T$1, Keys extends keyof T$1 = keyof T$1, S$1 extends boolean = true> = { [K in Keys]: T$1[K] extends AnyFn ? Reactified<T$1[K], S$1> : T$1[K] };
|
|
669
795
|
|
|
670
796
|
/**
|
|
671
797
|
* Apply `reactify` to an object
|
|
672
798
|
*
|
|
673
799
|
* @__NO_SIDE_EFFECTS__
|
|
674
800
|
*/
|
|
675
|
-
export declare function reactifyObject<T extends object, Keys extends keyof T>(obj: T, keys?: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>;
|
|
801
|
+
export declare function reactifyObject<T$1 extends object, Keys extends keyof T$1>(obj: T$1, keys?: (keyof T$1)[]): ReactifyObjectReturn<T$1, Keys, true>;
|
|
676
802
|
|
|
677
|
-
export declare function reactifyObject<T extends object, S extends boolean = true>(obj: T, options?: ReactifyObjectOptions<S>): ReactifyObjectReturn<T, keyof T, S>;
|
|
803
|
+
export declare function reactifyObject<T$1 extends object, S$1 extends boolean = true>(obj: T$1, options?: ReactifyObjectOptions<S$1>): ReactifyObjectReturn<T$1, keyof T$1, S$1>;
|
|
678
804
|
|
|
679
|
-
export declare interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
|
|
805
|
+
export declare interface ReactifyObjectOptions<T$1 extends boolean> extends ReactifyOptions<T$1> {
|
|
680
806
|
/**
|
|
681
807
|
* Includes names from Object.getOwnPropertyNames
|
|
682
808
|
*
|
|
@@ -685,48 +811,46 @@ export declare interface ReactifyObjectOptions<T extends boolean> extends Reacti
|
|
|
685
811
|
includeOwnProperties?: boolean;
|
|
686
812
|
}
|
|
687
813
|
|
|
688
|
-
declare type ReactifyObjectReturn<T, Keys extends keyof T, S extends boolean = true> = ReactifyNested<T, Keys, S>;
|
|
814
|
+
export declare type ReactifyObjectReturn<T$1, Keys extends keyof T$1, S$1 extends boolean = true> = ReactifyNested<T$1, Keys, S$1>;
|
|
689
815
|
|
|
690
|
-
export declare interface ReactifyOptions<T extends boolean> {
|
|
816
|
+
export declare interface ReactifyOptions<T$1 extends boolean> {
|
|
691
817
|
/**
|
|
692
818
|
* Accept passing a function as a reactive getter
|
|
693
819
|
*
|
|
694
820
|
* @default true
|
|
695
821
|
*/
|
|
696
|
-
computedGetter?: T;
|
|
822
|
+
computedGetter?: T$1;
|
|
697
823
|
}
|
|
698
824
|
|
|
699
|
-
declare type ReactifyReturn<T extends AnyFn = AnyFn, K extends boolean = true> = Reactified<T, K>;
|
|
825
|
+
export declare type ReactifyReturn<T$1 extends AnyFn = AnyFn, K$1 extends boolean = true> = Reactified<T$1, K$1>;
|
|
700
826
|
|
|
701
827
|
/**
|
|
702
828
|
* Computed reactive object.
|
|
703
829
|
*/
|
|
704
|
-
export declare function reactiveComputed<T extends object>(fn: ComputedGetter<T>): ReactiveComputedReturn<T>;
|
|
830
|
+
export declare function reactiveComputed<T$1 extends object>(fn: ComputedGetter<T$1>): ReactiveComputedReturn<T$1>;
|
|
705
831
|
|
|
706
|
-
declare type ReactiveComputedReturn<T extends object> = UnwrapNestedRefs<T>;
|
|
832
|
+
export declare type ReactiveComputedReturn<T$1 extends object> = UnwrapNestedRefs<T$1>;
|
|
707
833
|
|
|
708
|
-
export declare function reactiveOmit<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): ReactiveOmitReturn<T, K>;
|
|
834
|
+
export declare function reactiveOmit<T$1 extends object, K$1 extends keyof T$1>(obj: T$1, ...keys: (K$1 | K$1[])[]): ReactiveOmitReturn<T$1, K$1>;
|
|
709
835
|
|
|
710
|
-
export declare function reactiveOmit<T extends object>(obj: T, predicate: ReactiveOmitPredicate<T>): ReactiveOmitReturn<T>;
|
|
836
|
+
export declare function reactiveOmit<T$1 extends object>(obj: T$1, predicate: ReactiveOmitPredicate<T$1>): ReactiveOmitReturn<T$1>;
|
|
711
837
|
|
|
712
|
-
export declare type ReactiveOmitPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
838
|
+
export declare type ReactiveOmitPredicate<T$1> = (value: T$1[keyof T$1], key: keyof T$1) => boolean;
|
|
713
839
|
|
|
714
|
-
declare type ReactiveOmitReturn<T extends object, K extends keyof T | undefined = undefined> = [K] extends [undefined] ? Partial<T> : Omit<T, Extract<K, keyof T>>;
|
|
840
|
+
export declare type ReactiveOmitReturn<T$1 extends object, K$1 extends keyof T$1 | undefined = undefined> = [K$1] extends [undefined] ? Partial<T$1> : Omit<T$1, Extract<K$1, keyof T$1>>;
|
|
715
841
|
|
|
716
|
-
export declare function reactivePick<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): ReactivePickReturn<T, K>;
|
|
842
|
+
export declare function reactivePick<T$1 extends object, K$1 extends keyof T$1>(obj: T$1, ...keys: (K$1 | K$1[])[]): ReactivePickReturn<T$1, K$1>;
|
|
717
843
|
|
|
718
|
-
export declare function reactivePick<T extends object>(obj: T, predicate: ReactivePickPredicate<T>): ReactivePickReturn<T, keyof T>;
|
|
844
|
+
export declare function reactivePick<T$1 extends object>(obj: T$1, predicate: ReactivePickPredicate<T$1>): ReactivePickReturn<T$1, keyof T$1>;
|
|
719
845
|
|
|
720
|
-
export declare type ReactivePickPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
|
|
846
|
+
export declare type ReactivePickPredicate<T$1> = (value: T$1[keyof T$1], key: keyof T$1) => boolean;
|
|
721
847
|
|
|
722
|
-
declare type ReactivePickReturn<T extends object, K extends keyof T> = {
|
|
723
|
-
[S in K]: UnwrapRef<T[S]>;
|
|
724
|
-
};
|
|
848
|
+
export declare type ReactivePickReturn<T$1 extends object, K$1 extends keyof T$1> = { [S in K$1]: UnwrapRef<T$1[S]> };
|
|
725
849
|
|
|
726
850
|
/**
|
|
727
851
|
* Maybe it's a computed ref, or a readonly value, or a getter function
|
|
728
852
|
*/
|
|
729
|
-
export declare type ReadonlyRefOrGetter<T> = ComputedRef<T> | (() => T);
|
|
853
|
+
export declare type ReadonlyRefOrGetter<T$1> = ComputedRef<T$1> | (() => T$1);
|
|
730
854
|
|
|
731
855
|
/**
|
|
732
856
|
* Create a ref which will be reset to the default value after some time.
|
|
@@ -735,30 +859,33 @@ export declare type ReadonlyRefOrGetter<T> = ComputedRef<T> | (() => T);
|
|
|
735
859
|
* @param defaultValue The value which will be set.
|
|
736
860
|
* @param afterMs A zero-or-greater delay in milliseconds.
|
|
737
861
|
*/
|
|
738
|
-
declare function refAutoReset<T>(defaultValue: MaybeRefOrGetter<T>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T>;
|
|
739
|
-
export { refAutoReset as autoResetRef }
|
|
740
|
-
export { refAutoReset }
|
|
862
|
+
export declare function refAutoReset<T$1>(defaultValue: MaybeRefOrGetter<T$1>, afterMs?: MaybeRefOrGetter<number>): RefAutoResetReturn<T$1>;
|
|
741
863
|
|
|
742
|
-
declare type RefAutoResetReturn<T = any> = Ref<T>;
|
|
864
|
+
export declare type RefAutoResetReturn<T$1 = any> = Ref<T$1>;
|
|
743
865
|
|
|
744
866
|
/**
|
|
745
867
|
* Debounce updates of a ref.
|
|
746
868
|
*
|
|
747
869
|
* @return A new debounced ref.
|
|
748
870
|
*/
|
|
749
|
-
declare function refDebounced<T>(value: Ref<T>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T>;
|
|
750
|
-
export { refDebounced as debouncedRef }
|
|
751
|
-
export { refDebounced }
|
|
752
|
-
export { refDebounced as useDebounce }
|
|
871
|
+
export declare function refDebounced<T$1>(value: Ref<T$1>, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): RefDebouncedReturn<T$1>;
|
|
753
872
|
|
|
754
|
-
declare type RefDebouncedReturn<T = any> = Readonly<Ref<T>>;
|
|
873
|
+
export declare type RefDebouncedReturn<T$1 = any> = Readonly<Ref<T$1>>;
|
|
755
874
|
|
|
756
875
|
/**
|
|
757
876
|
* Apply default value to a ref.
|
|
758
877
|
*
|
|
759
878
|
* @__NO_SIDE_EFFECTS__
|
|
760
879
|
*/
|
|
761
|
-
export declare function refDefault<T>(source: Ref<T | undefined | null>, defaultValue: T): Ref<T>;
|
|
880
|
+
export declare function refDefault<T$1>(source: Ref<T$1 | undefined | null>, defaultValue: T$1): Ref<T$1>;
|
|
881
|
+
|
|
882
|
+
/**
|
|
883
|
+
* Create a ref with manual reset functionality.
|
|
884
|
+
*
|
|
885
|
+
* @see https://vueuse.org/refManualReset
|
|
886
|
+
* @param defaultValue The value which will be set.
|
|
887
|
+
*/
|
|
888
|
+
export declare function refManualReset<T$1>(defaultValue: MaybeRefOrGetter<T$1>): ManualResetRefReturn<T$1>;
|
|
762
889
|
|
|
763
890
|
/**
|
|
764
891
|
* Throttle execution of a function. Especially useful for rate limiting
|
|
@@ -769,44 +896,28 @@ export declare function refDefault<T>(source: Ref<T | undefined | null>, default
|
|
|
769
896
|
* @param trailing if true, update the value again after the delay time is up
|
|
770
897
|
* @param leading if true, update the value on the leading edge of the ms timeout
|
|
771
898
|
*/
|
|
772
|
-
declare function refThrottled<T = any>(value: Ref<T>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T>;
|
|
773
|
-
export { refThrottled }
|
|
774
|
-
export { refThrottled as throttledRef }
|
|
775
|
-
export { refThrottled as useThrottle }
|
|
899
|
+
export declare function refThrottled<T$1 = any>(value: Ref<T$1>, delay?: number, trailing?: boolean, leading?: boolean): RefThrottledReturn<T$1>;
|
|
776
900
|
|
|
777
|
-
declare type RefThrottledReturn<T = any> = Ref<T>;
|
|
901
|
+
export declare type RefThrottledReturn<T$1 = any> = Ref<T$1>;
|
|
778
902
|
|
|
779
903
|
/**
|
|
780
904
|
* Fine-grained controls over ref and its reactivity.
|
|
781
905
|
*
|
|
782
906
|
* @__NO_SIDE_EFFECTS__
|
|
783
907
|
*/
|
|
784
|
-
export declare function refWithControl<T>(initial: T, options?: ControlledRefOptions<T>):
|
|
785
|
-
get: (tracking?: boolean) => T;
|
|
786
|
-
set: (value: T, triggering?: boolean) => void;
|
|
787
|
-
untrackedGet: () => T;
|
|
788
|
-
silentSet: (v: T) => void;
|
|
789
|
-
peek: () => T;
|
|
790
|
-
lay: (v: T) => void;
|
|
791
|
-
}> &
|
|
908
|
+
export declare function refWithControl<T$1>(initial: T$1, options?: ControlledRefOptions<T$1>): vue0.ShallowUnwrapRef<{
|
|
909
|
+
get: (tracking?: boolean) => T$1;
|
|
910
|
+
set: (value: T$1, triggering?: boolean) => void;
|
|
911
|
+
untrackedGet: () => T$1;
|
|
912
|
+
silentSet: (v: T$1) => void;
|
|
913
|
+
peek: () => T$1;
|
|
914
|
+
lay: (v: T$1) => void;
|
|
915
|
+
}> & vue0.Ref<T$1, T$1>;
|
|
792
916
|
|
|
793
917
|
/**
|
|
794
918
|
* A ref that allow to set null or undefined
|
|
795
919
|
*/
|
|
796
|
-
export declare type RemovableRef<T> =
|
|
797
|
-
get value(): T;
|
|
798
|
-
set value(value: T | null | undefined);
|
|
799
|
-
};
|
|
800
|
-
|
|
801
|
-
/**
|
|
802
|
-
* @deprecated use `toRef` instead
|
|
803
|
-
*/
|
|
804
|
-
export declare const resolveRef: typeof toRef;
|
|
805
|
-
|
|
806
|
-
/**
|
|
807
|
-
* @deprecated use `toValue` instead
|
|
808
|
-
*/
|
|
809
|
-
export declare const resolveUnref: typeof toValue_2;
|
|
920
|
+
export declare type RemovableRef<T$1> = Ref<T$1, T$1 | null | undefined>;
|
|
810
921
|
|
|
811
922
|
export declare interface Serializer<T> {
|
|
812
923
|
read: (raw: string) => T;
|
|
@@ -818,18 +929,18 @@ export declare interface SerializerAsync<T> {
|
|
|
818
929
|
write: (value: T) => Awaitable<string>;
|
|
819
930
|
}
|
|
820
931
|
|
|
821
|
-
export declare function set<T>(ref: Ref<T>, value: T): void;
|
|
932
|
+
export declare function set<T$1>(ref: Ref<T$1>, value: T$1): void;
|
|
822
933
|
|
|
823
|
-
export declare function set<O extends object, K extends keyof O>(target: O, key: K, value: O[K]): void;
|
|
934
|
+
export declare function set<O extends object, K$1 extends keyof O>(target: O, key: K$1, value: O[K$1]): void;
|
|
824
935
|
|
|
825
|
-
declare type ShallowOrDeepRef<T = any, D extends boolean = false> = D extends true ? Ref<T> : ShallowRef<T>;
|
|
936
|
+
export declare type ShallowOrDeepRef<T$1 = any, D extends boolean = false> = D extends true ? Ref<T$1> : ShallowRef<T$1>;
|
|
826
937
|
|
|
827
|
-
export declare type ShallowUnwrapRef<T> = T extends Ref<infer P> ? P : T;
|
|
938
|
+
export declare type ShallowUnwrapRef<T$1> = T$1 extends Ref<infer P> ? P : T$1;
|
|
828
939
|
|
|
829
|
-
declare type SharedComposableReturn<T extends AnyFn = AnyFn> = T;
|
|
940
|
+
export declare type SharedComposableReturn<T$1 extends AnyFn = AnyFn> = T$1;
|
|
830
941
|
|
|
831
|
-
export declare interface SingletonPromiseReturn<T> {
|
|
832
|
-
(): Promise<T>;
|
|
942
|
+
export declare interface SingletonPromiseReturn<T$1> {
|
|
943
|
+
(): Promise<T$1>;
|
|
833
944
|
/**
|
|
834
945
|
* Reset current staled promise.
|
|
835
946
|
* await it to have proper shutdown.
|
|
@@ -837,7 +948,7 @@ export declare interface SingletonPromiseReturn<T> {
|
|
|
837
948
|
reset: () => Promise<void>;
|
|
838
949
|
}
|
|
839
950
|
|
|
840
|
-
declare type SpecificFieldPartial<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
|
|
951
|
+
declare type SpecificFieldPartial<T$1, K$1 extends keyof T$1> = Partial<Pick<T$1, K$1>> & Omit<T$1, K$1>;
|
|
841
952
|
|
|
842
953
|
export declare interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
843
954
|
/**
|
|
@@ -854,15 +965,15 @@ export declare interface Stoppable<StartFnArgs extends any[] = any[]> {
|
|
|
854
965
|
start: (...args: StartFnArgs) => void;
|
|
855
966
|
}
|
|
856
967
|
|
|
857
|
-
declare type StrictIncludeMap<IncludeType extends 'LR' | 'RL', D extends Exclude<Direction, 'both'>, L, R> = (Equal<[IncludeType, D], ['LR', 'ltr']> & Equal<[IncludeType, D], ['RL', 'rtl']>) extends true ? {
|
|
858
|
-
transform?: SpecificFieldPartial<Pick<Transform<L, R>, D>, D>;
|
|
968
|
+
declare type StrictIncludeMap<IncludeType extends 'LR' | 'RL', D extends Exclude<Direction, 'both'>, L, R$1> = (Equal<[IncludeType, D], ['LR', 'ltr']> & Equal<[IncludeType, D], ['RL', 'rtl']>) extends true ? {
|
|
969
|
+
transform?: SpecificFieldPartial<Pick<Transform<L, R$1>, D>, D>;
|
|
859
970
|
} : {
|
|
860
|
-
transform: Pick<Transform<L, R>, D>;
|
|
971
|
+
transform: Pick<Transform<L, R$1>, D>;
|
|
861
972
|
};
|
|
862
973
|
|
|
863
|
-
declare type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direction, L, R> = D extends 'both' ? {
|
|
864
|
-
transform: SpecificFieldPartial<Transform<L, R>, IncludeType extends 'LR' ? 'ltr' : 'rtl'>;
|
|
865
|
-
} : D extends Exclude<Direction, 'both'> ? StrictIncludeMap<IncludeType, D, L, R> : never;
|
|
974
|
+
declare type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direction, L, R$1> = D extends 'both' ? {
|
|
975
|
+
transform: SpecificFieldPartial<Transform<L, R$1>, IncludeType extends 'LR' ? 'ltr' : 'rtl'>;
|
|
976
|
+
} : D extends Exclude<Direction, 'both'> ? StrictIncludeMap<IncludeType, D, L, R$1> : never;
|
|
866
977
|
|
|
867
978
|
/**
|
|
868
979
|
* Two-way refs synchronization.
|
|
@@ -873,9 +984,9 @@ declare type StrictIncludeType<IncludeType extends 'LR' | 'RL', D extends Direct
|
|
|
873
984
|
* 3. L ⊆ R
|
|
874
985
|
* 4. L ∩ R = ∅
|
|
875
986
|
*/
|
|
876
|
-
export declare function syncRef<L, R, D extends Direction = 'both'>(left: Ref<L>, right: Ref<R>, ...[options]: Equal<L, R> extends true ? [options?: SyncRefOptions<L, R, D>] : [options: SyncRefOptions<L, R, D>]): () => void;
|
|
987
|
+
export declare function syncRef<L, R$1, D extends Direction = 'both'>(left: Ref<L>, right: Ref<R$1>, ...[options]: Equal<L, R$1> extends true ? [options?: SyncRefOptions<L, R$1, D>] : [options: SyncRefOptions<L, R$1, D>]): () => void;
|
|
877
988
|
|
|
878
|
-
export declare type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlushSync & {
|
|
989
|
+
export declare type SyncRefOptions<L, R$1, D extends Direction> = ConfigurableFlushSync & {
|
|
879
990
|
/**
|
|
880
991
|
* Watch deeply
|
|
881
992
|
*
|
|
@@ -894,7 +1005,7 @@ export declare type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlus
|
|
|
894
1005
|
* @default 'both'
|
|
895
1006
|
*/
|
|
896
1007
|
direction?: D;
|
|
897
|
-
} & TransformType<D, L, R>;
|
|
1008
|
+
} & TransformType<D, L, R$1>;
|
|
898
1009
|
|
|
899
1010
|
/**
|
|
900
1011
|
* Keep target ref(s) in sync with the source ref
|
|
@@ -902,7 +1013,7 @@ export declare type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlus
|
|
|
902
1013
|
* @param source source ref
|
|
903
1014
|
* @param targets
|
|
904
1015
|
*/
|
|
905
|
-
export declare function syncRefs<T>(source: WatchSource<T>, targets: Ref<T> | Ref<T>[], options?: SyncRefsOptions):
|
|
1016
|
+
export declare function syncRefs<T$1>(source: WatchSource<T$1>, targets: Ref<T$1> | Ref<T$1>[], options?: SyncRefsOptions): vue0.WatchHandle;
|
|
906
1017
|
|
|
907
1018
|
export declare interface SyncRefsOptions extends ConfigurableFlushSync {
|
|
908
1019
|
/**
|
|
@@ -919,6 +1030,12 @@ export declare interface SyncRefsOptions extends ConfigurableFlushSync {
|
|
|
919
1030
|
immediate?: boolean;
|
|
920
1031
|
}
|
|
921
1032
|
|
|
1033
|
+
/** @deprecated use `refThrottled` instead */
|
|
1034
|
+
export declare const throttledRef: typeof refThrottled;
|
|
1035
|
+
|
|
1036
|
+
/** @deprecated use `watchThrottled` instead */
|
|
1037
|
+
export declare const throttledWatch: typeof watchThrottled;
|
|
1038
|
+
|
|
922
1039
|
/**
|
|
923
1040
|
* Create an EventFilter that throttle the events
|
|
924
1041
|
*/
|
|
@@ -945,6 +1062,17 @@ export declare interface ThrottleFilterOptions {
|
|
|
945
1062
|
rejectOnCancel?: boolean;
|
|
946
1063
|
}
|
|
947
1064
|
|
|
1065
|
+
/**
|
|
1066
|
+
* Universal timer handle that works in both browser and Node.js environments
|
|
1067
|
+
*/
|
|
1068
|
+
export declare type TimerHandle = ReturnType<typeof setTimeout> | undefined;
|
|
1069
|
+
|
|
1070
|
+
export declare const timestamp: () => number;
|
|
1071
|
+
|
|
1072
|
+
export declare function toArray<T$1>(value: T$1 | readonly T$1[]): readonly T$1[];
|
|
1073
|
+
|
|
1074
|
+
export declare function toArray<T$1>(value: T$1 | T$1[]): T$1[];
|
|
1075
|
+
|
|
948
1076
|
export declare interface ToDataURLOptions extends UseBase64Options {
|
|
949
1077
|
/**
|
|
950
1078
|
* MIME type
|
|
@@ -956,28 +1084,30 @@ export declare interface ToDataURLOptions extends UseBase64Options {
|
|
|
956
1084
|
quality?: any;
|
|
957
1085
|
}
|
|
958
1086
|
|
|
1087
|
+
export declare type ToggleFn = (value?: boolean) => void;
|
|
1088
|
+
|
|
959
1089
|
/**
|
|
960
1090
|
* Converts ref to reactive.
|
|
961
1091
|
*
|
|
962
1092
|
* @see https://vueuse.org/toReactive
|
|
963
1093
|
* @param objectRef A ref of object
|
|
964
1094
|
*/
|
|
965
|
-
export declare function toReactive<T extends object>(objectRef: MaybeRef<T>): UnwrapNestedRefs<T>;
|
|
1095
|
+
export declare function toReactive<T$1 extends object>(objectRef: MaybeRef<T$1>): UnwrapNestedRefs<T$1>;
|
|
966
1096
|
|
|
967
1097
|
/**
|
|
968
1098
|
* Normalize value/ref/getter to `ref` or `computed`.
|
|
969
1099
|
*/
|
|
970
|
-
export declare function toRef<T>(r: () => T): Readonly<Ref<T>>;
|
|
1100
|
+
export declare function toRef<T$1>(r: () => T$1): Readonly<Ref<T$1>>;
|
|
971
1101
|
|
|
972
|
-
export declare function toRef<T>(r: ComputedRef<T>): ComputedRef<T>;
|
|
1102
|
+
export declare function toRef<T$1>(r: ComputedRef<T$1>): ComputedRef<T$1>;
|
|
973
1103
|
|
|
974
|
-
export declare function toRef<T>(r: MaybeRefOrGetter<T>): Ref<T>;
|
|
1104
|
+
export declare function toRef<T$1>(r: MaybeRefOrGetter<T$1>): Ref<T$1>;
|
|
975
1105
|
|
|
976
|
-
export declare function toRef<T>(r: T): Ref<T>;
|
|
1106
|
+
export declare function toRef<T$1>(r: T$1): Ref<T$1>;
|
|
977
1107
|
|
|
978
|
-
export declare function toRef<T extends object, K extends keyof T>(object: T, key: K): ToRef<T[K]>;
|
|
1108
|
+
export declare function toRef<T$1 extends object, K$1 extends keyof T$1>(object: T$1, key: K$1): ToRef<T$1[K$1]>;
|
|
979
1109
|
|
|
980
|
-
export declare function toRef<T extends object, K extends keyof T>(object: T, key: K, defaultValue: T[K]): ToRef<Exclude<T[K], undefined>>;
|
|
1110
|
+
export declare function toRef<T$1 extends object, K$1 extends keyof T$1>(object: T$1, key: K$1, defaultValue: T$1[K$1]): ToRef<Exclude<T$1[K$1], undefined>>;
|
|
981
1111
|
|
|
982
1112
|
/**
|
|
983
1113
|
* Extended `toRefs` that also accepts refs of an object.
|
|
@@ -986,7 +1116,7 @@ export declare function toRef<T extends object, K extends keyof T>(object: T, ke
|
|
|
986
1116
|
* @param objectRef A ref or normal object or array.
|
|
987
1117
|
* @param options Options
|
|
988
1118
|
*/
|
|
989
|
-
export declare function toRefs<T extends object>(objectRef: MaybeRef<T>, options?: ToRefsOptions): ToRefs<T>;
|
|
1119
|
+
export declare function toRefs<T$1 extends object>(objectRef: MaybeRef<T$1>, options?: ToRefsOptions): ToRefs<T$1>;
|
|
990
1120
|
|
|
991
1121
|
export declare interface ToRefsOptions {
|
|
992
1122
|
/**
|
|
@@ -997,30 +1127,55 @@ export declare interface ToRefsOptions {
|
|
|
997
1127
|
replaceRef?: MaybeRefOrGetter<boolean>;
|
|
998
1128
|
}
|
|
999
1129
|
|
|
1130
|
+
declare interface Transform<L, R$1> {
|
|
1131
|
+
ltr: (left: L) => R$1;
|
|
1132
|
+
rtl: (right: R$1) => L;
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
declare type TransformType<D extends Direction, L, R$1> = Equal<L, R$1> extends true ? EqualType<D, L, R$1> : IncludeButNotEqual<L, R$1> extends true ? StrictIncludeType<'LR', D, L, R$1> : IncludeButNotEqual<R$1, L> extends true ? StrictIncludeType<'RL', D, L, R$1> : IntersectButNotEqual<L, R$1> extends true ? IntersectButNotEqualType<D, L, R$1> : NotIntersect<L, R$1> extends true ? NotIntersectType<D, L, R$1> : never;
|
|
1136
|
+
|
|
1000
1137
|
/**
|
|
1001
|
-
*
|
|
1138
|
+
* Call onBeforeMount() if it's inside a component lifecycle, if not, just call the function
|
|
1002
1139
|
*
|
|
1003
|
-
* @
|
|
1140
|
+
* @param fn
|
|
1141
|
+
* @param sync if set to false, it will run in the nextTick() of Vue
|
|
1142
|
+
* @param target
|
|
1004
1143
|
*/
|
|
1005
|
-
export declare
|
|
1144
|
+
export declare function tryOnBeforeMount(fn: Fn, sync?: boolean, target?: ComponentInternalInstance | null): void;
|
|
1006
1145
|
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1146
|
+
/**
|
|
1147
|
+
* Call onBeforeUnmount() if it's inside a component lifecycle, if not, do nothing
|
|
1148
|
+
*
|
|
1149
|
+
* @param fn
|
|
1150
|
+
* @param target
|
|
1151
|
+
*/
|
|
1152
|
+
export declare function tryOnBeforeUnmount(fn: Fn, target?: ComponentInternalInstance | null): void;
|
|
1011
1153
|
|
|
1012
|
-
|
|
1154
|
+
/**
|
|
1155
|
+
* Call onMounted() if it's inside a component lifecycle, if not, just call the function
|
|
1156
|
+
*
|
|
1157
|
+
* @param fn
|
|
1158
|
+
* @param sync if set to false, it will run in the nextTick() of Vue
|
|
1159
|
+
* @param target
|
|
1160
|
+
*/
|
|
1161
|
+
export declare function tryOnMounted(fn: Fn, sync?: boolean, target?: ComponentInternalInstance | null): void;
|
|
1013
1162
|
|
|
1014
1163
|
/**
|
|
1015
1164
|
* Call onScopeDispose() if it's inside an effect scope lifecycle, if not, do nothing
|
|
1016
1165
|
*
|
|
1017
1166
|
* @param fn
|
|
1018
1167
|
*/
|
|
1019
|
-
export declare function tryOnScopeDispose(fn: Fn): boolean;
|
|
1168
|
+
export declare function tryOnScopeDispose(fn: Fn, failSilently?: boolean): boolean;
|
|
1020
1169
|
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1170
|
+
/**
|
|
1171
|
+
* Call onUnmounted() if it's inside a component lifecycle, if not, do nothing
|
|
1172
|
+
*
|
|
1173
|
+
* @param fn
|
|
1174
|
+
* @param target
|
|
1175
|
+
*/
|
|
1176
|
+
export declare function tryOnUnmounted(fn: Fn, target?: ComponentInternalInstance | null): void;
|
|
1177
|
+
|
|
1178
|
+
export declare type UnrefFn<T> = T extends ((...args: infer A) => infer R) ? (...args: { [K in keyof A]: MaybeRef<A[K]> }) => R : never;
|
|
1024
1179
|
|
|
1025
1180
|
/**
|
|
1026
1181
|
* Promised one-time watch for changes
|
|
@@ -1035,19 +1190,19 @@ export declare type UnrefFn<T> = T extends (...args: infer A) => infer R ? (...a
|
|
|
1035
1190
|
* alert('Counter is now larger than 7!')
|
|
1036
1191
|
* ```
|
|
1037
1192
|
*/
|
|
1038
|
-
export declare function until<T extends unknown[]>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilArrayInstance<T>;
|
|
1193
|
+
export declare function until<T$1 extends unknown[]>(r: WatchSource<T$1> | MaybeRefOrGetter<T$1>): UntilArrayInstance<T$1>;
|
|
1039
1194
|
|
|
1040
|
-
export declare function until<T>(r: WatchSource<T> | MaybeRefOrGetter<T>): UntilValueInstance<T>;
|
|
1195
|
+
export declare function until<T$1>(r: WatchSource<T$1> | MaybeRefOrGetter<T$1>): UntilValueInstance<T$1>;
|
|
1041
1196
|
|
|
1042
|
-
export declare interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
|
|
1043
|
-
readonly not: UntilArrayInstance<T>;
|
|
1044
|
-
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T>>>, options?: UntilToMatchOptions) => Promise<T>;
|
|
1197
|
+
export declare interface UntilArrayInstance<T$1> extends UntilBaseInstance<T$1> {
|
|
1198
|
+
readonly not: UntilArrayInstance<T$1>;
|
|
1199
|
+
toContains: (value: MaybeRefOrGetter<ElementOf<ShallowUnwrapRef<T$1>>>, options?: UntilToMatchOptions) => Promise<T$1>;
|
|
1045
1200
|
}
|
|
1046
1201
|
|
|
1047
|
-
declare interface UntilBaseInstance<T, Not extends boolean = false> {
|
|
1048
|
-
toMatch: (<U extends T = T>(condition: (v: T) => v is U, options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, U>> : Promise<U>) & ((condition: (v: T) => boolean, options?: UntilToMatchOptions) => Promise<T>);
|
|
1049
|
-
changed: (options?: UntilToMatchOptions) => Promise<T>;
|
|
1050
|
-
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T>;
|
|
1202
|
+
export declare interface UntilBaseInstance<T$1, Not extends boolean = false> {
|
|
1203
|
+
toMatch: (<U extends T$1 = T$1>(condition: (v: T$1) => v is U, options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, U>> : Promise<U>) & ((condition: (v: T$1) => boolean, options?: UntilToMatchOptions) => Promise<T$1>);
|
|
1204
|
+
changed: (options?: UntilToMatchOptions) => Promise<T$1>;
|
|
1205
|
+
changedTimes: (n?: number, options?: UntilToMatchOptions) => Promise<T$1>;
|
|
1051
1206
|
}
|
|
1052
1207
|
|
|
1053
1208
|
export declare interface UntilToMatchOptions {
|
|
@@ -1069,7 +1224,7 @@ export declare interface UntilToMatchOptions {
|
|
|
1069
1224
|
*
|
|
1070
1225
|
* @default 'sync'
|
|
1071
1226
|
*/
|
|
1072
|
-
flush?:
|
|
1227
|
+
flush?: WatchOptionFlush;
|
|
1073
1228
|
/**
|
|
1074
1229
|
* `deep` option for internal watch
|
|
1075
1230
|
*
|
|
@@ -1078,22 +1233,22 @@ export declare interface UntilToMatchOptions {
|
|
|
1078
1233
|
deep?: WatchOptions['deep'];
|
|
1079
1234
|
}
|
|
1080
1235
|
|
|
1081
|
-
export declare interface UntilValueInstance<T, Not extends boolean = false> extends UntilBaseInstance<T, Not> {
|
|
1082
|
-
readonly not: UntilValueInstance<T, Not extends true ? false : true>;
|
|
1083
|
-
toBe: <P = T>(value: MaybeRefOrGetter<P>, options?: UntilToMatchOptions) => Not extends true ? Promise<T> : Promise<P>;
|
|
1084
|
-
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T & Falsy> : Promise<Exclude<T, Falsy>>;
|
|
1085
|
-
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, null>> : Promise<null>;
|
|
1086
|
-
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T, undefined>> : Promise<undefined>;
|
|
1087
|
-
toBeNaN: (options?: UntilToMatchOptions) => Promise<T>;
|
|
1236
|
+
export declare interface UntilValueInstance<T$1, Not extends boolean = false> extends UntilBaseInstance<T$1, Not> {
|
|
1237
|
+
readonly not: UntilValueInstance<T$1, Not extends true ? false : true>;
|
|
1238
|
+
toBe: <P = T$1>(value: MaybeRefOrGetter<P>, options?: UntilToMatchOptions) => Not extends true ? Promise<T$1> : Promise<P>;
|
|
1239
|
+
toBeTruthy: (options?: UntilToMatchOptions) => Not extends true ? Promise<T$1 & Falsy> : Promise<Exclude<T$1, Falsy>>;
|
|
1240
|
+
toBeNull: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, null>> : Promise<null>;
|
|
1241
|
+
toBeUndefined: (options?: UntilToMatchOptions) => Not extends true ? Promise<Exclude<T$1, undefined>> : Promise<undefined>;
|
|
1242
|
+
toBeNaN: (options?: UntilToMatchOptions) => Promise<T$1>;
|
|
1088
1243
|
}
|
|
1089
1244
|
|
|
1090
1245
|
export declare type UrlParams = Record<string, string[] | string>;
|
|
1091
1246
|
|
|
1092
|
-
export declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, key?: keyof T, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
1247
|
+
export declare function useArrayDifference<T$1>(list: MaybeRefOrGetter<T$1[]>, values: MaybeRefOrGetter<T$1[]>, key?: keyof T$1, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T$1>;
|
|
1093
1248
|
|
|
1094
|
-
export declare function useArrayDifference<T>(list: MaybeRefOrGetter<T[]>, values: MaybeRefOrGetter<T[]>, compareFn?: (value: T, othVal: T) => boolean, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T>;
|
|
1249
|
+
export declare function useArrayDifference<T$1>(list: MaybeRefOrGetter<T$1[]>, values: MaybeRefOrGetter<T$1[]>, compareFn?: (value: T$1, othVal: T$1) => boolean, options?: UseArrayDifferenceOptions): UseArrayDifferenceReturn<T$1>;
|
|
1095
1250
|
|
|
1096
|
-
declare interface UseArrayDifferenceOptions {
|
|
1251
|
+
export declare interface UseArrayDifferenceOptions {
|
|
1097
1252
|
/**
|
|
1098
1253
|
* Returns asymmetric difference
|
|
1099
1254
|
*
|
|
@@ -1103,7 +1258,7 @@ declare interface UseArrayDifferenceOptions {
|
|
|
1103
1258
|
symmetric?: boolean;
|
|
1104
1259
|
}
|
|
1105
1260
|
|
|
1106
|
-
declare type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;
|
|
1261
|
+
export declare type UseArrayDifferenceReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
1107
1262
|
|
|
1108
1263
|
/**
|
|
1109
1264
|
* Reactive `Array.every`
|
|
@@ -1116,9 +1271,9 @@ declare type UseArrayDifferenceReturn<T = any> = ComputedRef<T[]>;
|
|
|
1116
1271
|
*
|
|
1117
1272
|
* @__NO_SIDE_EFFECTS__
|
|
1118
1273
|
*/
|
|
1119
|
-
export declare function useArrayEvery<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayEveryReturn;
|
|
1274
|
+
export declare function useArrayEvery<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArrayEveryReturn;
|
|
1120
1275
|
|
|
1121
|
-
declare type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
1276
|
+
export declare type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
1122
1277
|
|
|
1123
1278
|
/**
|
|
1124
1279
|
* Reactive `Array.filter`
|
|
@@ -1131,11 +1286,11 @@ declare type UseArrayEveryReturn = ComputedRef<boolean>;
|
|
|
1131
1286
|
*
|
|
1132
1287
|
* @__NO_SIDE_EFFECTS__
|
|
1133
1288
|
*/
|
|
1134
|
-
export declare function useArrayFilter<T, S extends T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => element is S): UseArrayFilterReturn<S>;
|
|
1289
|
+
export declare function useArrayFilter<T$1, S$1 extends T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => element is S$1): UseArrayFilterReturn<S$1>;
|
|
1135
1290
|
|
|
1136
|
-
export declare function useArrayFilter<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => unknown): UseArrayFilterReturn<T>;
|
|
1291
|
+
export declare function useArrayFilter<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => unknown): UseArrayFilterReturn<T$1>;
|
|
1137
1292
|
|
|
1138
|
-
declare type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
1293
|
+
export declare type UseArrayFilterReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
1139
1294
|
|
|
1140
1295
|
/**
|
|
1141
1296
|
* Reactive `Array.find`
|
|
@@ -1148,7 +1303,7 @@ declare type UseArrayFilterReturn<T = any> = ComputedRef<T[]>;
|
|
|
1148
1303
|
*
|
|
1149
1304
|
* @__NO_SIDE_EFFECTS__
|
|
1150
1305
|
*/
|
|
1151
|
-
export declare function useArrayFind<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindReturn<T>;
|
|
1306
|
+
export declare function useArrayFind<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean): UseArrayFindReturn<T$1>;
|
|
1152
1307
|
|
|
1153
1308
|
/**
|
|
1154
1309
|
* Reactive `Array.findIndex`
|
|
@@ -1161,9 +1316,9 @@ export declare function useArrayFind<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<
|
|
|
1161
1316
|
*
|
|
1162
1317
|
* @__NO_SIDE_EFFECTS__
|
|
1163
1318
|
*/
|
|
1164
|
-
export declare function useArrayFindIndex<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArrayFindIndexReturn;
|
|
1319
|
+
export declare function useArrayFindIndex<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArrayFindIndexReturn;
|
|
1165
1320
|
|
|
1166
|
-
declare type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
1321
|
+
export declare type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
1167
1322
|
|
|
1168
1323
|
/**
|
|
1169
1324
|
* Reactive `Array.findLast`
|
|
@@ -1176,11 +1331,11 @@ declare type UseArrayFindIndexReturn = ComputedRef<number>;
|
|
|
1176
1331
|
*
|
|
1177
1332
|
* @__NO_SIDE_EFFECTS__
|
|
1178
1333
|
*/
|
|
1179
|
-
export declare function useArrayFindLast<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => boolean): UseArrayFindLastReturn<T>;
|
|
1334
|
+
export declare function useArrayFindLast<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean): UseArrayFindLastReturn<T$1>;
|
|
1180
1335
|
|
|
1181
|
-
declare type UseArrayFindLastReturn<T = any> = ComputedRef<T | undefined>;
|
|
1336
|
+
export declare type UseArrayFindLastReturn<T$1 = any> = ComputedRef<T$1 | undefined>;
|
|
1182
1337
|
|
|
1183
|
-
declare type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
1338
|
+
export declare type UseArrayFindReturn<T$1 = any> = ComputedRef<T$1 | undefined>;
|
|
1184
1339
|
|
|
1185
1340
|
/**
|
|
1186
1341
|
* Reactive `Array.includes`
|
|
@@ -1191,20 +1346,20 @@ declare type UseArrayFindReturn<T = any> = ComputedRef<T | undefined>;
|
|
|
1191
1346
|
*
|
|
1192
1347
|
* @__NO_SIDE_EFFECTS__
|
|
1193
1348
|
*/
|
|
1194
|
-
export declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, comparator?: UseArrayIncludesComparatorFn<T, V>): UseArrayIncludesReturn;
|
|
1349
|
+
export declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, comparator?: UseArrayIncludesComparatorFn<T$1, V$1>): UseArrayIncludesReturn;
|
|
1195
1350
|
|
|
1196
|
-
export declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, comparator?: keyof T): UseArrayIncludesReturn;
|
|
1351
|
+
export declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, comparator?: keyof T$1): UseArrayIncludesReturn;
|
|
1197
1352
|
|
|
1198
|
-
export declare function useArrayIncludes<T, V = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, options?: UseArrayIncludesOptions<T, V>): UseArrayIncludesReturn;
|
|
1353
|
+
export declare function useArrayIncludes<T$1, V$1 = any>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, value: MaybeRefOrGetter<V$1>, options?: UseArrayIncludesOptions<T$1, V$1>): UseArrayIncludesReturn;
|
|
1199
1354
|
|
|
1200
|
-
export declare type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeRefOrGetter<T>[]) => boolean);
|
|
1355
|
+
export declare type UseArrayIncludesComparatorFn<T$1, V$1> = ((element: T$1, value: V$1, index: number, array: MaybeRefOrGetter<T$1>[]) => boolean);
|
|
1201
1356
|
|
|
1202
|
-
export declare interface UseArrayIncludesOptions<T, V> {
|
|
1357
|
+
export declare interface UseArrayIncludesOptions<T$1, V$1> {
|
|
1203
1358
|
fromIndex?: number;
|
|
1204
|
-
comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T;
|
|
1359
|
+
comparator?: UseArrayIncludesComparatorFn<T$1, V$1> | keyof T$1;
|
|
1205
1360
|
}
|
|
1206
1361
|
|
|
1207
|
-
declare type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
1362
|
+
export declare type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
1208
1363
|
|
|
1209
1364
|
/**
|
|
1210
1365
|
* Reactive `Array.join`
|
|
@@ -1219,7 +1374,7 @@ declare type UseArrayIncludesReturn = ComputedRef<boolean>;
|
|
|
1219
1374
|
*/
|
|
1220
1375
|
export declare function useArrayJoin(list: MaybeRefOrGetter<MaybeRefOrGetter<any>[]>, separator?: MaybeRefOrGetter<string>): UseArrayJoinReturn;
|
|
1221
1376
|
|
|
1222
|
-
declare type UseArrayJoinReturn = ComputedRef<string>;
|
|
1377
|
+
export declare type UseArrayJoinReturn = ComputedRef<string>;
|
|
1223
1378
|
|
|
1224
1379
|
/**
|
|
1225
1380
|
* Reactive `Array.map`
|
|
@@ -1232,9 +1387,9 @@ declare type UseArrayJoinReturn = ComputedRef<string>;
|
|
|
1232
1387
|
*
|
|
1233
1388
|
* @__NO_SIDE_EFFECTS__
|
|
1234
1389
|
*/
|
|
1235
|
-
export declare function useArrayMap<T, U = T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: T[]) => U): UseArrayMapReturn<U>;
|
|
1390
|
+
export declare function useArrayMap<T$1, U$1 = T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: T$1[]) => U$1): UseArrayMapReturn<U$1>;
|
|
1236
1391
|
|
|
1237
|
-
declare type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
1392
|
+
export declare type UseArrayMapReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
1238
1393
|
|
|
1239
1394
|
/**
|
|
1240
1395
|
* Reactive `Array.reduce`
|
|
@@ -1247,7 +1402,7 @@ declare type UseArrayMapReturn<T = any> = ComputedRef<T[]>;
|
|
|
1247
1402
|
*
|
|
1248
1403
|
* @__NO_SIDE_EFFECTS__
|
|
1249
1404
|
*/
|
|
1250
|
-
export declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<T, T, T>):
|
|
1405
|
+
export declare function useArrayReduce<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, reducer: UseArrayReducer<T$1, T$1, T$1>): UseArrayReduceReturn<T$1>;
|
|
1251
1406
|
|
|
1252
1407
|
/**
|
|
1253
1408
|
* Reactive `Array.reduce`
|
|
@@ -1261,9 +1416,11 @@ export declare function useArrayReduce<T>(list: MaybeRefOrGetter<MaybeRefOrGette
|
|
|
1261
1416
|
*
|
|
1262
1417
|
* @__NO_SIDE_EFFECTS__
|
|
1263
1418
|
*/
|
|
1264
|
-
export declare function useArrayReduce<T, U>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, reducer: UseArrayReducer<U, T, U>, initialValue: MaybeRefOrGetter<U>):
|
|
1419
|
+
export declare function useArrayReduce<T$1, U$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, reducer: UseArrayReducer<U$1, T$1, U$1>, initialValue: MaybeRefOrGetter<U$1>): UseArrayReduceReturn<U$1>;
|
|
1420
|
+
|
|
1421
|
+
export declare type UseArrayReducer<PV, CV, R$1> = (previousValue: PV, currentValue: CV, currentIndex: number) => R$1;
|
|
1265
1422
|
|
|
1266
|
-
export declare type
|
|
1423
|
+
export declare type UseArrayReduceReturn<T$1 = any> = ComputedRef<T$1>;
|
|
1267
1424
|
|
|
1268
1425
|
/**
|
|
1269
1426
|
* Reactive `Array.some`
|
|
@@ -1276,9 +1433,9 @@ export declare type UseArrayReducer<PV, CV, R> = (previousValue: PV, currentValu
|
|
|
1276
1433
|
*
|
|
1277
1434
|
* @__NO_SIDE_EFFECTS__
|
|
1278
1435
|
*/
|
|
1279
|
-
export declare function useArraySome<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, fn: (element: T, index: number, array: MaybeRefOrGetter<T>[]) => unknown): UseArraySomeReturn;
|
|
1436
|
+
export declare function useArraySome<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, fn: (element: T$1, index: number, array: MaybeRefOrGetter<T$1>[]) => unknown): UseArraySomeReturn;
|
|
1280
1437
|
|
|
1281
|
-
declare type UseArraySomeReturn = ComputedRef<boolean>;
|
|
1438
|
+
export declare type UseArraySomeReturn = ComputedRef<boolean>;
|
|
1282
1439
|
|
|
1283
1440
|
/**
|
|
1284
1441
|
* reactive unique array
|
|
@@ -1289,9 +1446,9 @@ declare type UseArraySomeReturn = ComputedRef<boolean>;
|
|
|
1289
1446
|
*
|
|
1290
1447
|
* @__NO_SIDE_EFFECTS__
|
|
1291
1448
|
*/
|
|
1292
|
-
export declare function useArrayUnique<T>(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, compareFn?: (a: T, b: T, array: T[]) => boolean): UseArrayUniqueReturn<T>;
|
|
1449
|
+
export declare function useArrayUnique<T$1>(list: MaybeRefOrGetter<MaybeRefOrGetter<T$1>[]>, compareFn?: (a: T$1, b: T$1, array: T$1[]) => boolean): UseArrayUniqueReturn<T$1>;
|
|
1293
1450
|
|
|
1294
|
-
declare type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
1451
|
+
export declare type UseArrayUniqueReturn<T$1 = any> = ComputedRef<T$1[]>;
|
|
1295
1452
|
|
|
1296
1453
|
/**
|
|
1297
1454
|
* Asynchronous queue task controller.
|
|
@@ -1300,9 +1457,7 @@ declare type UseArrayUniqueReturn<T = any> = ComputedRef<T[]>;
|
|
|
1300
1457
|
* @param tasks
|
|
1301
1458
|
* @param options
|
|
1302
1459
|
*/
|
|
1303
|
-
export declare function useAsyncQueue<T extends any[], S = MapQueueTask<T>>(tasks: S & Array<UseAsyncQueueTask<any>>, options?: UseAsyncQueueOptions): UseAsyncQueueReturn<{
|
|
1304
|
-
[P in keyof T]: UseAsyncQueueResult<T[P]>;
|
|
1305
|
-
}>;
|
|
1460
|
+
export declare function useAsyncQueue<T extends any[], S = MapQueueTask<T>>(tasks: S & Array<UseAsyncQueueTask<any>>, options?: UseAsyncQueueOptions): UseAsyncQueueReturn<{ [P in keyof T]: UseAsyncQueueResult<T[P]> }>;
|
|
1306
1461
|
|
|
1307
1462
|
export declare interface UseAsyncQueueOptions {
|
|
1308
1463
|
/**
|
|
@@ -1456,7 +1611,7 @@ export declare interface UseBase64Return {
|
|
|
1456
1611
|
* @param options
|
|
1457
1612
|
*
|
|
1458
1613
|
*/
|
|
1459
|
-
export declare function useBroadcastChannel<D, P>(options: UseBroadcastChannelOptions): UseBroadcastChannelReturn<D, P>;
|
|
1614
|
+
export declare function useBroadcastChannel<D, P$1>(options: UseBroadcastChannelOptions): UseBroadcastChannelReturn<D, P$1>;
|
|
1460
1615
|
|
|
1461
1616
|
export declare interface UseBroadcastChannelOptions extends ConfigurableWindow {
|
|
1462
1617
|
/**
|
|
@@ -1465,11 +1620,11 @@ export declare interface UseBroadcastChannelOptions extends ConfigurableWindow {
|
|
|
1465
1620
|
name: string;
|
|
1466
1621
|
}
|
|
1467
1622
|
|
|
1468
|
-
export declare interface UseBroadcastChannelReturn<D, P> {
|
|
1623
|
+
export declare interface UseBroadcastChannelReturn<D, P$1> {
|
|
1469
1624
|
isSupported: ComputedRef<boolean>;
|
|
1470
1625
|
channel: Ref<BroadcastChannel | undefined>;
|
|
1471
1626
|
data: Ref<D>;
|
|
1472
|
-
post: (data: P) => void;
|
|
1627
|
+
post: (data: P$1) => void;
|
|
1473
1628
|
close: () => void;
|
|
1474
1629
|
error: ShallowRef<Event | null>;
|
|
1475
1630
|
isClosed: ShallowRef<boolean>;
|
|
@@ -1514,8 +1669,7 @@ export declare type UseBrowserLocationReturn = ReturnType<typeof useBrowserLocat
|
|
|
1514
1669
|
|
|
1515
1670
|
export declare function useCached<T, D extends boolean = true>(refValue: Ref<T>, comparator?: (a: T, b: T) => boolean, options?: UseCachedOptions<D>): UseCachedReturn<T, D>;
|
|
1516
1671
|
|
|
1517
|
-
declare interface UseCachedOptions<D extends boolean = true> extends ConfigurableDeepRefs<D>, WatchOptions {
|
|
1518
|
-
}
|
|
1672
|
+
declare interface UseCachedOptions<D extends boolean = true> extends ConfigurableDeepRefs<D>, WatchOptions {}
|
|
1519
1673
|
|
|
1520
1674
|
declare type UseCachedReturn<T = any, D extends boolean = true> = ShallowOrDeepRef<T, D>;
|
|
1521
1675
|
|
|
@@ -1559,7 +1713,7 @@ export declare interface UseClonedReturn<T> {
|
|
|
1559
1713
|
* @param options
|
|
1560
1714
|
*/
|
|
1561
1715
|
export declare function useCounter(initialValue?: MaybeRef<number>, options?: UseCounterOptions): {
|
|
1562
|
-
count: Readonly<Ref<number, number> |
|
|
1716
|
+
count: Readonly<Ref<number, number> | vue0.ShallowRef<number, number> | vue0.WritableComputedRef<number, number>>;
|
|
1563
1717
|
inc: (delta?: number) => number;
|
|
1564
1718
|
dec: (delta?: number) => number;
|
|
1565
1719
|
get: () => number;
|
|
@@ -1567,11 +1721,44 @@ export declare function useCounter(initialValue?: MaybeRef<number>, options?: Us
|
|
|
1567
1721
|
reset: (val?: number) => number;
|
|
1568
1722
|
};
|
|
1569
1723
|
|
|
1570
|
-
declare interface UseCounterOptions {
|
|
1724
|
+
export declare interface UseCounterOptions {
|
|
1571
1725
|
min?: number;
|
|
1572
1726
|
max?: number;
|
|
1573
1727
|
}
|
|
1574
1728
|
|
|
1729
|
+
export declare interface UseCounterReturn {
|
|
1730
|
+
/**
|
|
1731
|
+
* The current value of the counter.
|
|
1732
|
+
*/
|
|
1733
|
+
readonly count: Readonly<Ref<number>>;
|
|
1734
|
+
/**
|
|
1735
|
+
* Increment the counter.
|
|
1736
|
+
*
|
|
1737
|
+
* @param {number} [delta=1] The number to increment.
|
|
1738
|
+
*/
|
|
1739
|
+
inc: (delta?: number) => void;
|
|
1740
|
+
/**
|
|
1741
|
+
* Decrement the counter.
|
|
1742
|
+
*
|
|
1743
|
+
* @param {number} [delta=1] The number to decrement.
|
|
1744
|
+
*/
|
|
1745
|
+
dec: (delta?: number) => void;
|
|
1746
|
+
/**
|
|
1747
|
+
* Get the current value of the counter.
|
|
1748
|
+
*/
|
|
1749
|
+
get: () => number;
|
|
1750
|
+
/**
|
|
1751
|
+
* Set the counter to a new value.
|
|
1752
|
+
*
|
|
1753
|
+
* @param val The new value of the counter.
|
|
1754
|
+
*/
|
|
1755
|
+
set: (val: number) => void;
|
|
1756
|
+
/**
|
|
1757
|
+
* Reset the counter to an initial value.
|
|
1758
|
+
*/
|
|
1759
|
+
reset: (val?: number) => number;
|
|
1760
|
+
}
|
|
1761
|
+
|
|
1575
1762
|
/**
|
|
1576
1763
|
* Cycle through a list of items
|
|
1577
1764
|
*
|
|
@@ -1634,6 +1821,9 @@ export declare interface UseDateFormatOptions {
|
|
|
1634
1821
|
|
|
1635
1822
|
export declare type UseDateFormatReturn = ComputedRef<string>;
|
|
1636
1823
|
|
|
1824
|
+
/** @deprecated use `refDebounced` instead */
|
|
1825
|
+
export declare const useDebounce: typeof refDebounced;
|
|
1826
|
+
|
|
1637
1827
|
/**
|
|
1638
1828
|
* Shorthand for [useRefHistory](https://vueuse.org/useRefHistory) with debounce filter.
|
|
1639
1829
|
*
|
|
@@ -1657,30 +1847,30 @@ export declare function useDebouncedRefHistory<Raw, Serialized = Raw>(source: Re
|
|
|
1657
1847
|
*
|
|
1658
1848
|
* @__NO_SIDE_EFFECTS__
|
|
1659
1849
|
*/
|
|
1660
|
-
export declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T>;
|
|
1850
|
+
export declare function useDebounceFn<T$1 extends FunctionArgs>(fn: T$1, ms?: MaybeRefOrGetter<number>, options?: DebounceFilterOptions): UseDebounceFnReturn<T$1>;
|
|
1661
1851
|
|
|
1662
|
-
declare type UseDebounceFnReturn<T extends FunctionArgs> = PromisifyFn<T>;
|
|
1852
|
+
export declare type UseDebounceFnReturn<T$1 extends FunctionArgs> = PromisifyFn<T$1>;
|
|
1663
1853
|
|
|
1664
|
-
export declare function useEventBus<T = unknown, P = any>(key: EventBusIdentifier<T>): UseEventBusReturn<T, P>;
|
|
1854
|
+
export declare function useEventBus<T = unknown, P$1 = any>(key: EventBusIdentifier<T>): UseEventBusReturn<T, P$1>;
|
|
1665
1855
|
|
|
1666
|
-
export declare interface UseEventBusReturn<T, P> {
|
|
1856
|
+
export declare interface UseEventBusReturn<T, P$1> {
|
|
1667
1857
|
/**
|
|
1668
1858
|
* Subscribe to an event. When calling emit, the listeners will execute.
|
|
1669
1859
|
* @param listener watch listener.
|
|
1670
1860
|
* @returns a stop function to remove the current callback.
|
|
1671
1861
|
*/
|
|
1672
|
-
on: (listener: EventBusListener<T, P>) => Fn;
|
|
1862
|
+
on: (listener: EventBusListener<T, P$1>) => Fn;
|
|
1673
1863
|
/**
|
|
1674
1864
|
* Similar to `on`, but only fires once
|
|
1675
1865
|
* @param listener watch listener.
|
|
1676
1866
|
* @returns a stop function to remove the current callback.
|
|
1677
1867
|
*/
|
|
1678
|
-
once: (listener: EventBusListener<T, P>) => Fn;
|
|
1868
|
+
once: (listener: EventBusListener<T, P$1>) => Fn;
|
|
1679
1869
|
/**
|
|
1680
1870
|
* Emit an event, the corresponding event listeners will execute.
|
|
1681
1871
|
* @param event data sent.
|
|
1682
1872
|
*/
|
|
1683
|
-
emit: (event?: T, payload?: P) => void;
|
|
1873
|
+
emit: (event?: T, payload?: P$1) => void;
|
|
1684
1874
|
/**
|
|
1685
1875
|
* Remove the corresponding listener.
|
|
1686
1876
|
* @param listener watch listener.
|
|
@@ -1850,7 +2040,7 @@ declare interface UseIdleOptions extends ConfigurableWindow, ConfigurableEventFi
|
|
|
1850
2040
|
initialState?: boolean;
|
|
1851
2041
|
}
|
|
1852
2042
|
|
|
1853
|
-
declare interface UseIdleReturn {
|
|
2043
|
+
declare interface UseIdleReturn extends Stoppable {
|
|
1854
2044
|
idle: ShallowRef<boolean>;
|
|
1855
2045
|
lastActive: ShallowRef<number>;
|
|
1856
2046
|
reset: () => void;
|
|
@@ -1897,7 +2087,7 @@ export declare interface UseIntervalFnOptions {
|
|
|
1897
2087
|
immediateCallback?: boolean;
|
|
1898
2088
|
}
|
|
1899
2089
|
|
|
1900
|
-
declare type UseIntervalFnReturn = Pausable;
|
|
2090
|
+
export declare type UseIntervalFnReturn = Pausable;
|
|
1901
2091
|
|
|
1902
2092
|
export declare interface UseIntervalOptions<Controls extends boolean> {
|
|
1903
2093
|
/**
|
|
@@ -1918,6 +2108,8 @@ export declare interface UseIntervalOptions<Controls extends boolean> {
|
|
|
1918
2108
|
callback?: (count: number) => void;
|
|
1919
2109
|
}
|
|
1920
2110
|
|
|
2111
|
+
export declare type UseIntervalReturn = Readonly<ShallowRef<number>> | Readonly<UseIntervalControls & Pausable>;
|
|
2112
|
+
|
|
1921
2113
|
/**
|
|
1922
2114
|
* Records the timestamp of the last change
|
|
1923
2115
|
*
|
|
@@ -1931,6 +2123,8 @@ export declare interface UseLastChangedOptions<Immediate extends boolean, Initia
|
|
|
1931
2123
|
initialValue?: InitialValue;
|
|
1932
2124
|
}
|
|
1933
2125
|
|
|
2126
|
+
export declare type UseLastChangedReturn = Readonly<ShallowRef<number | null>> | Readonly<ShallowRef<number>>;
|
|
2127
|
+
|
|
1934
2128
|
/**
|
|
1935
2129
|
* Track the change history of a ref, also provides undo and redo functionality.
|
|
1936
2130
|
*
|
|
@@ -2060,7 +2254,7 @@ export declare type UseNowReturn = ReturnType<typeof useNow>;
|
|
|
2060
2254
|
* @see https://vueuse.org/useObjectUrl
|
|
2061
2255
|
* @param object
|
|
2062
2256
|
*/
|
|
2063
|
-
export declare function useObjectUrl(object: MaybeRefOrGetter<Blob | MediaSource | null | undefined>): Readonly<
|
|
2257
|
+
export declare function useObjectUrl(object: MaybeRefOrGetter<Blob | MediaSource | null | undefined>): Readonly<vue0.Ref<string | undefined, string | undefined>>;
|
|
2064
2258
|
|
|
2065
2259
|
export declare function useOffsetPagination(options: Omit<UseOffsetPaginationOptions, 'total'>): UseOffsetPaginationInfinityPageReturn;
|
|
2066
2260
|
|
|
@@ -2142,7 +2336,7 @@ export declare interface UseRefHistoryOptions<Raw, Serialized = Raw> extends Con
|
|
|
2142
2336
|
*
|
|
2143
2337
|
* @default 'pre'
|
|
2144
2338
|
*/
|
|
2145
|
-
flush?:
|
|
2339
|
+
flush?: WatchOptionFlush;
|
|
2146
2340
|
/**
|
|
2147
2341
|
* Maximum number of history to be kept. Default to unlimited.
|
|
2148
2342
|
*/
|
|
@@ -2213,7 +2407,7 @@ export declare interface UseRefHistoryReturn<Raw, Serialized> extends UseManualR
|
|
|
2213
2407
|
* @__NO_SIDE_EFFECTS__
|
|
2214
2408
|
*/
|
|
2215
2409
|
declare function useShare(shareOptions?: MaybeRefOrGetter<UseShareOptions>, options?: ConfigurableNavigator): {
|
|
2216
|
-
isSupported:
|
|
2410
|
+
isSupported: vue0.ComputedRef<boolean>;
|
|
2217
2411
|
share: (overrideOptions?: MaybeRefOrGetter<UseShareOptions>) => Promise<void>;
|
|
2218
2412
|
};
|
|
2219
2413
|
|
|
@@ -2303,8 +2497,8 @@ export declare interface UseStepperReturn<StepName, Steps, Step> {
|
|
|
2303
2497
|
}
|
|
2304
2498
|
|
|
2305
2499
|
declare function useTextareaAutosize(options?: UseTextareaAutosizeOptions): {
|
|
2306
|
-
textarea:
|
|
2307
|
-
input:
|
|
2500
|
+
textarea: vue0.Ref<HTMLTextAreaElement | null | undefined, HTMLTextAreaElement | null | undefined>;
|
|
2501
|
+
input: vue0.Ref<string, string>;
|
|
2308
2502
|
triggerResize: () => void;
|
|
2309
2503
|
};
|
|
2310
2504
|
|
|
@@ -2314,7 +2508,7 @@ export declare interface UseTextareaAutosizeOptions extends ConfigurableWindow {
|
|
|
2314
2508
|
/** Textarea content. */
|
|
2315
2509
|
input?: MaybeRef<string>;
|
|
2316
2510
|
/** Watch sources that should trigger a textarea resize. */
|
|
2317
|
-
watch?: WatchSource |
|
|
2511
|
+
watch?: WatchSource | MultiWatchSources;
|
|
2318
2512
|
/** Function called when the textarea size changes. */
|
|
2319
2513
|
onResize?: () => void;
|
|
2320
2514
|
/** Specify style target to apply the height based on textarea content. If not provided it will use textarea it self. */
|
|
@@ -2325,6 +2519,9 @@ export declare interface UseTextareaAutosizeOptions extends ConfigurableWindow {
|
|
|
2325
2519
|
|
|
2326
2520
|
export declare type UseTextareaAutosizeReturn = ReturnType<typeof useTextareaAutosize>;
|
|
2327
2521
|
|
|
2522
|
+
/** @deprecated use `refThrottled` instead */
|
|
2523
|
+
export declare const useThrottle: typeof refThrottled;
|
|
2524
|
+
|
|
2328
2525
|
/**
|
|
2329
2526
|
* Shorthand for [useRefHistory](https://vueuse.org/useRefHistory) with throttled filter.
|
|
2330
2527
|
*
|
|
@@ -2360,7 +2557,7 @@ export declare type UseThrottledRefHistoryReturn<Raw, Serialized = Raw> = UseRef
|
|
|
2360
2557
|
*
|
|
2361
2558
|
* @__NO_SIDE_EFFECTS__
|
|
2362
2559
|
*/
|
|
2363
|
-
export declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T>;
|
|
2560
|
+
export declare function useThrottleFn<T$1 extends FunctionArgs>(fn: T$1, ms?: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): PromisifyFn<T$1>;
|
|
2364
2561
|
|
|
2365
2562
|
/**
|
|
2366
2563
|
* Reactive time ago formatter.
|
|
@@ -2448,7 +2645,7 @@ export declare interface UseTimeoutFnOptions {
|
|
|
2448
2645
|
immediateCallback?: boolean;
|
|
2449
2646
|
}
|
|
2450
2647
|
|
|
2451
|
-
declare type UseTimeoutFnReturn<CallbackFn extends AnyFn> = Stoppable<Parameters<CallbackFn> | []>;
|
|
2648
|
+
export declare type UseTimeoutFnReturn<CallbackFn extends AnyFn> = Stoppable<Parameters<CallbackFn> | []>;
|
|
2452
2649
|
|
|
2453
2650
|
export declare interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
|
|
2454
2651
|
/**
|
|
@@ -2465,6 +2662,10 @@ export declare interface UseTimeoutOptions<Controls extends boolean> extends Use
|
|
|
2465
2662
|
|
|
2466
2663
|
export declare function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeRefOrGetter<number>, options?: UseTimeoutFnOptions): Pausable;
|
|
2467
2664
|
|
|
2665
|
+
export declare type UseTimeoutReturn = ComputedRef<boolean> | {
|
|
2666
|
+
readonly ready: ComputedRef<boolean>;
|
|
2667
|
+
} & Stoppable;
|
|
2668
|
+
|
|
2468
2669
|
/**
|
|
2469
2670
|
* Reactive current timestamp.
|
|
2470
2671
|
*
|
|
@@ -2510,15 +2711,22 @@ export declare interface UseTimestampOptions<Controls extends boolean> {
|
|
|
2510
2711
|
|
|
2511
2712
|
export declare type UseTimestampReturn = ReturnType<typeof useTimestamp>;
|
|
2512
2713
|
|
|
2513
|
-
|
|
2714
|
+
/**
|
|
2715
|
+
* @deprecated use UseTimeoutReturn instead
|
|
2716
|
+
*/
|
|
2717
|
+
export declare type UseTimoutReturn = UseTimeoutReturn;
|
|
2718
|
+
|
|
2719
|
+
export declare function useToggle<Truthy, Falsy$1, T$1 = Truthy | Falsy$1>(initialValue: Ref<T$1>, options?: UseToggleOptions<Truthy, Falsy$1>): (value?: T$1) => T$1;
|
|
2514
2720
|
|
|
2515
|
-
export declare function useToggle<Truthy = true, Falsy = false, T = Truthy | Falsy>(initialValue?: T, options?: UseToggleOptions<Truthy, Falsy>): [ShallowRef<T>, (value?: T) => T];
|
|
2721
|
+
export declare function useToggle<Truthy = true, Falsy$1 = false, T$1 = Truthy | Falsy$1>(initialValue?: T$1, options?: UseToggleOptions<Truthy, Falsy$1>): [ShallowRef<T$1>, (value?: T$1) => T$1];
|
|
2516
2722
|
|
|
2517
|
-
export declare interface UseToggleOptions<Truthy, Falsy> {
|
|
2723
|
+
export declare interface UseToggleOptions<Truthy, Falsy$1> {
|
|
2518
2724
|
truthyValue?: MaybeRefOrGetter<Truthy>;
|
|
2519
|
-
falsyValue?: MaybeRefOrGetter<Falsy>;
|
|
2725
|
+
falsyValue?: MaybeRefOrGetter<Falsy$1>;
|
|
2520
2726
|
}
|
|
2521
2727
|
|
|
2728
|
+
export declare type UseToggleReturn = [ShallowRef<boolean>, ToggleFn] | ToggleFn;
|
|
2729
|
+
|
|
2522
2730
|
/**
|
|
2523
2731
|
* Reactively convert a string ref to number.
|
|
2524
2732
|
*
|
|
@@ -2660,9 +2868,11 @@ export declare interface UseWebSocketOptions {
|
|
|
2660
2868
|
/**
|
|
2661
2869
|
* Delay for reconnect, in milliseconds
|
|
2662
2870
|
*
|
|
2871
|
+
* Or you can pass a function to calculate the delay based on the number of retries.
|
|
2872
|
+
*
|
|
2663
2873
|
* @default 1000
|
|
2664
2874
|
*/
|
|
2665
|
-
delay?: number;
|
|
2875
|
+
delay?: number | ((retries: number) => number);
|
|
2666
2876
|
/**
|
|
2667
2877
|
* On maximum retry times reached.
|
|
2668
2878
|
*/
|
|
@@ -2736,7 +2946,7 @@ export declare interface UseWebSocketReturn<T> {
|
|
|
2736
2946
|
*/
|
|
2737
2947
|
export declare function useWebWorkerFn<T extends (...fnArgs: any[]) => any>(fn: T, options?: UseWebWorkerOptions): {
|
|
2738
2948
|
workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>;
|
|
2739
|
-
workerStatus:
|
|
2949
|
+
workerStatus: vue0.ShallowRef<WebWorkerStatus, WebWorkerStatus>;
|
|
2740
2950
|
workerTerminate: (status?: WebWorkerStatus) => void;
|
|
2741
2951
|
};
|
|
2742
2952
|
|
|
@@ -2771,13 +2981,13 @@ export declare interface UseWebWorkerReturn<Data = any> {
|
|
|
2771
2981
|
*
|
|
2772
2982
|
* @see https://vueuse.org/watchArray
|
|
2773
2983
|
*/
|
|
2774
|
-
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>):
|
|
2984
|
+
export declare function watchArray<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1[]> | T$1[], cb: WatchArrayCallback<T$1[], Immediate extends true ? T$1[] | undefined : T$1[]>, options?: WatchOptions<Immediate>): vue0.WatchHandle;
|
|
2775
2985
|
|
|
2776
|
-
export declare type WatchArrayCallback<V = any, OV = any> = (value: V, oldValue: OV, added: V, removed: OV, onCleanup: (cleanupFn: () => void) => void) => any;
|
|
2986
|
+
export declare type WatchArrayCallback<V$1 = any, OV = any> = (value: V$1, oldValue: OV, added: V$1, removed: OV, onCleanup: (cleanupFn: () => void) => void) => any;
|
|
2777
2987
|
|
|
2778
|
-
export declare function watchAtMost<T extends Readonly<
|
|
2988
|
+
export declare function watchAtMost<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
2779
2989
|
|
|
2780
|
-
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;
|
|
2990
|
+
export declare function watchAtMost<T$1, Immediate extends Readonly<boolean> = false>(sources: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn;
|
|
2781
2991
|
|
|
2782
2992
|
export declare interface WatchAtMostOptions<Immediate> extends WatchWithFilterOptions<Immediate> {
|
|
2783
2993
|
count: MaybeRefOrGetter<number>;
|
|
@@ -2785,34 +2995,32 @@ export declare interface WatchAtMostOptions<Immediate> extends WatchWithFilterOp
|
|
|
2785
2995
|
|
|
2786
2996
|
export declare interface WatchAtMostReturn {
|
|
2787
2997
|
stop: WatchStopHandle;
|
|
2998
|
+
pause: () => void;
|
|
2999
|
+
resume: () => void;
|
|
2788
3000
|
count: ShallowRef<number>;
|
|
2789
3001
|
}
|
|
2790
3002
|
|
|
2791
|
-
declare function watchDebounced<T extends Readonly<
|
|
3003
|
+
export declare function watchDebounced<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
2792
3004
|
|
|
2793
|
-
declare function watchDebounced<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchDebouncedOptions<Immediate>):
|
|
3005
|
+
export declare function watchDebounced<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
2794
3006
|
|
|
2795
|
-
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>):
|
|
2796
|
-
export { watchDebounced as debouncedWatch }
|
|
2797
|
-
export { watchDebounced }
|
|
3007
|
+
export declare function watchDebounced<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchDebouncedOptions<Immediate>): WatchHandle;
|
|
2798
3008
|
|
|
2799
3009
|
export declare interface WatchDebouncedOptions<Immediate> extends WatchOptions<Immediate>, DebounceFilterOptions {
|
|
2800
3010
|
debounce?: MaybeRefOrGetter<number>;
|
|
2801
3011
|
}
|
|
2802
3012
|
|
|
2803
|
-
export declare function watchDeep<T extends Readonly<
|
|
3013
|
+
export declare function watchDeep<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
2804
3014
|
|
|
2805
|
-
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'>):
|
|
3015
|
+
export declare function watchDeep<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
2806
3016
|
|
|
2807
|
-
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'>):
|
|
3017
|
+
export declare function watchDeep<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: Omit<WatchOptions<Immediate>, 'deep'>): WatchHandle;
|
|
2808
3018
|
|
|
2809
|
-
declare function watchIgnorable<T extends Readonly<
|
|
3019
|
+
export declare function watchIgnorable<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
2810
3020
|
|
|
2811
|
-
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;
|
|
3021
|
+
export declare function watchIgnorable<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
2812
3022
|
|
|
2813
|
-
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;
|
|
2814
|
-
export { watchIgnorable as ignorableWatch }
|
|
2815
|
-
export { watchIgnorable }
|
|
3023
|
+
export declare function watchIgnorable<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchIgnorableReturn;
|
|
2816
3024
|
|
|
2817
3025
|
export declare interface WatchIgnorableReturn {
|
|
2818
3026
|
ignoreUpdates: IgnoredUpdater;
|
|
@@ -2820,39 +3028,40 @@ export declare interface WatchIgnorableReturn {
|
|
|
2820
3028
|
stop: WatchStopHandle;
|
|
2821
3029
|
}
|
|
2822
3030
|
|
|
2823
|
-
export declare function watchImmediate<T extends Readonly<
|
|
3031
|
+
export declare function watchImmediate<T$1 extends Readonly<MultiWatchSources>>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, true>>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2824
3032
|
|
|
2825
|
-
export declare function watchImmediate<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>):
|
|
3033
|
+
export declare function watchImmediate<T$1>(source: WatchSource<T$1>, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2826
3034
|
|
|
2827
|
-
export declare function watchImmediate<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>):
|
|
3035
|
+
export declare function watchImmediate<T$1 extends object>(source: T$1, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'immediate'>): WatchHandle;
|
|
2828
3036
|
|
|
2829
|
-
export declare function watchOnce<T extends Readonly<
|
|
3037
|
+
export declare function watchOnce<T$1 extends Readonly<MultiWatchSources>>(source: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, true>>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2830
3038
|
|
|
2831
|
-
export declare function watchOnce<T>(source: WatchSource<T>, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>):
|
|
3039
|
+
export declare function watchOnce<T$1>(source: WatchSource<T$1>, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2832
3040
|
|
|
2833
|
-
export declare function watchOnce<T extends object>(source: T, cb: WatchCallback<T, T | undefined>, options?: Omit<WatchOptions<true>, 'once'>):
|
|
3041
|
+
export declare function watchOnce<T$1 extends object>(source: T$1, cb: WatchCallback<T$1, T$1 | undefined>, options?: Omit<WatchOptions<true>, 'once'>): WatchHandle;
|
|
2834
3042
|
|
|
2835
|
-
declare
|
|
3043
|
+
export declare type WatchOptionFlush = WatchOptions['flush'];
|
|
2836
3044
|
|
|
2837
|
-
|
|
3045
|
+
/**
|
|
3046
|
+
* @deprecated This function will be removed in future version.
|
|
3047
|
+
*/
|
|
3048
|
+
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;
|
|
3049
|
+
|
|
3050
|
+
export declare function watchPausable<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
2838
3051
|
|
|
2839
|
-
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;
|
|
2840
|
-
export { watchPausable as pausableWatch }
|
|
2841
|
-
export { watchPausable }
|
|
3052
|
+
export declare function watchPausable<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
|
|
2842
3053
|
|
|
2843
|
-
declare type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
|
|
3054
|
+
export declare type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
|
|
2844
3055
|
|
|
2845
3056
|
export declare interface WatchPausableReturn extends Pausable {
|
|
2846
3057
|
stop: WatchStopHandle;
|
|
2847
3058
|
}
|
|
2848
3059
|
|
|
2849
|
-
declare function watchThrottled<T extends Readonly<
|
|
3060
|
+
export declare function watchThrottled<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
2850
3061
|
|
|
2851
|
-
declare function watchThrottled<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchThrottledOptions<Immediate>):
|
|
3062
|
+
export declare function watchThrottled<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
2852
3063
|
|
|
2853
|
-
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>):
|
|
2854
|
-
export { watchThrottled as throttledWatch }
|
|
2855
|
-
export { watchThrottled }
|
|
3064
|
+
export declare function watchThrottled<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchThrottledOptions<Immediate>): WatchHandle;
|
|
2856
3065
|
|
|
2857
3066
|
export declare interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
|
|
2858
3067
|
throttle?: MaybeRefOrGetter<number>;
|
|
@@ -2860,27 +3069,26 @@ export declare interface WatchThrottledOptions<Immediate> extends WatchOptions<I
|
|
|
2860
3069
|
leading?: boolean;
|
|
2861
3070
|
}
|
|
2862
3071
|
|
|
2863
|
-
export declare function watchTriggerable<T extends Readonly<
|
|
3072
|
+
export declare function watchTriggerable<T$1 extends Readonly<MultiWatchSources>, FnReturnT>(sources: [...T$1], cb: WatchTriggerableCallback<MapSources<T$1>, MapOldSources<T$1, true>, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2864
3073
|
|
|
2865
|
-
export declare function watchTriggerable<T, FnReturnT>(source: WatchSource<T>, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
3074
|
+
export declare function watchTriggerable<T$1, FnReturnT>(source: WatchSource<T$1>, cb: WatchTriggerableCallback<T$1, T$1 | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2866
3075
|
|
|
2867
|
-
export declare function watchTriggerable<T extends object, FnReturnT>(source: T, cb: WatchTriggerableCallback<T, T | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
3076
|
+
export declare function watchTriggerable<T$1 extends object, FnReturnT>(source: T$1, cb: WatchTriggerableCallback<T$1, T$1 | undefined, FnReturnT>, options?: WatchWithFilterOptions<boolean>): WatchTriggerableReturn<FnReturnT>;
|
|
2868
3077
|
|
|
2869
|
-
export declare type WatchTriggerableCallback<V = any, OV = any, R = void> = (value: V, oldValue: OV, onCleanup: OnCleanup) => R;
|
|
3078
|
+
export declare type WatchTriggerableCallback<V$1 = any, OV = any, R$1 = void> = (value: V$1, oldValue: OV, onCleanup: OnCleanup) => R$1;
|
|
2870
3079
|
|
|
2871
3080
|
export declare interface WatchTriggerableReturn<FnReturnT = void> extends WatchIgnorableReturn {
|
|
2872
3081
|
/** Execute `WatchCallback` immediately */
|
|
2873
3082
|
trigger: () => FnReturnT;
|
|
2874
3083
|
}
|
|
2875
3084
|
|
|
2876
|
-
export declare function watchWithFilter<T extends Readonly<
|
|
3085
|
+
export declare function watchWithFilter<T$1 extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: [...T$1], cb: WatchCallback<MapSources<T$1>, MapOldSources<T$1, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
2877
3086
|
|
|
2878
|
-
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>):
|
|
3087
|
+
export declare function watchWithFilter<T$1, Immediate extends Readonly<boolean> = false>(source: WatchSource<T$1>, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
2879
3088
|
|
|
2880
|
-
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>):
|
|
3089
|
+
export declare function watchWithFilter<T$1 extends object, Immediate extends Readonly<boolean> = false>(source: T$1, cb: WatchCallback<T$1, Immediate extends true ? T$1 | undefined : T$1>, options?: WatchWithFilterOptions<Immediate>): WatchHandle;
|
|
2881
3090
|
|
|
2882
|
-
declare interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {
|
|
2883
|
-
}
|
|
3091
|
+
export declare interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {}
|
|
2884
3092
|
|
|
2885
3093
|
declare type WebSocketHeartbeatMessage = string | ArrayBuffer | Blob;
|
|
2886
3094
|
|
|
@@ -2893,7 +3101,7 @@ export declare type WebWorkerStatus = 'PENDING' | 'SUCCESS' | 'RUNNING' | 'ERROR
|
|
|
2893
3101
|
*
|
|
2894
3102
|
* @see https://vueuse.org/whenever
|
|
2895
3103
|
*/
|
|
2896
|
-
export declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions):
|
|
3104
|
+
export declare function whenever<T$1>(source: WatchSource<T$1 | false | null | undefined>, cb: WatchCallback<T$1>, options?: WheneverOptions): vue0.WatchHandle;
|
|
2897
3105
|
|
|
2898
3106
|
export declare interface WheneverOptions extends WatchOptions {
|
|
2899
3107
|
/**
|
|
@@ -2908,17 +3116,16 @@ export declare interface WheneverOptions extends WatchOptions {
|
|
|
2908
3116
|
|
|
2909
3117
|
declare type WindowEventName = keyof WindowEventMap;
|
|
2910
3118
|
|
|
2911
|
-
export declare interface WritableComputedInjectOptions<T, K> {
|
|
2912
|
-
get: ComputedInjectGetter<T, K>;
|
|
2913
|
-
set: ComputedInjectSetter<K>;
|
|
3119
|
+
export declare interface WritableComputedInjectOptions<T, K$1> {
|
|
3120
|
+
get: ComputedInjectGetter<T, K$1>;
|
|
3121
|
+
set: ComputedInjectSetter<K$1>;
|
|
2914
3122
|
}
|
|
2915
3123
|
|
|
2916
|
-
export declare interface WritableComputedInjectOptionsWithDefault<T, K> {
|
|
2917
|
-
get: ComputedInjectGetterWithDefault<T, K>;
|
|
2918
|
-
set: ComputedInjectSetter<K>;
|
|
3124
|
+
export declare interface WritableComputedInjectOptionsWithDefault<T, K$1> {
|
|
3125
|
+
get: ComputedInjectGetterWithDefault<T, K$1>;
|
|
3126
|
+
set: ComputedInjectSetter<K$1>;
|
|
2919
3127
|
}
|
|
2920
3128
|
|
|
2921
|
-
export declare interface WritableComputedRefWithControl<T> extends WritableComputedRef<T>, ComputedWithControlRefExtra {
|
|
2922
|
-
}
|
|
3129
|
+
export declare interface WritableComputedRefWithControl<T$1> extends WritableComputedRef<T$1>, ComputedWithControlRefExtra {}
|
|
2923
3130
|
|
|
2924
3131
|
export { }
|