@vueuse/shared 9.0.0-beta.0 → 9.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/index.d.ts +11 -11
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -685,7 +685,7 @@ declare type UseDateFormatReturn = ReturnType<typeof useDateFormat>;
|
|
|
685
685
|
*/
|
|
686
686
|
declare function useDebounceFn<T extends FunctionArgs>(fn: T, ms?: MaybeComputedRef$1<number>, options?: DebounceFilterOptions): T;
|
|
687
687
|
|
|
688
|
-
interface
|
|
688
|
+
interface UseIntervalOptions<Controls extends boolean> {
|
|
689
689
|
/**
|
|
690
690
|
* Expose more controls
|
|
691
691
|
*
|
|
@@ -699,12 +699,12 @@ interface IntervalOptions<Controls extends boolean> {
|
|
|
699
699
|
*/
|
|
700
700
|
immediate?: boolean;
|
|
701
701
|
}
|
|
702
|
-
declare function useInterval(interval?: MaybeComputedRef<number>, options?:
|
|
703
|
-
declare function useInterval(interval: MaybeComputedRef<number>, options:
|
|
702
|
+
declare function useInterval(interval?: MaybeComputedRef<number>, options?: UseIntervalOptions<false>): Ref<number>;
|
|
703
|
+
declare function useInterval(interval: MaybeComputedRef<number>, options: UseIntervalOptions<true>): {
|
|
704
704
|
counter: Ref<number>;
|
|
705
705
|
} & Pausable;
|
|
706
706
|
|
|
707
|
-
interface
|
|
707
|
+
interface UseIntervalFnOptions {
|
|
708
708
|
/**
|
|
709
709
|
* Start the timer immediately
|
|
710
710
|
*
|
|
@@ -725,7 +725,7 @@ interface IntervalFnOptions {
|
|
|
725
725
|
* @param interval
|
|
726
726
|
* @param options
|
|
727
727
|
*/
|
|
728
|
-
declare function useIntervalFn(cb: Fn, interval?: MaybeComputedRef<number>, options?:
|
|
728
|
+
declare function useIntervalFn(cb: Fn, interval?: MaybeComputedRef<number>, options?: UseIntervalFnOptions): Pausable;
|
|
729
729
|
|
|
730
730
|
interface UseLastChangedOptions<Immediate extends boolean, InitialValue extends number | null | undefined = undefined> extends WatchOptions<Immediate> {
|
|
731
731
|
initialValue?: InitialValue;
|
|
@@ -755,7 +755,7 @@ declare function useLastChanged(source: WatchSource, options: UseLastChangedOpti
|
|
|
755
755
|
*/
|
|
756
756
|
declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeComputedRef<number>, trailing?: boolean, leading?: boolean): T;
|
|
757
757
|
|
|
758
|
-
interface
|
|
758
|
+
interface UseTimeoutFnOptions {
|
|
759
759
|
/**
|
|
760
760
|
* Start the timer immediate after calling this function
|
|
761
761
|
*
|
|
@@ -770,9 +770,9 @@ interface TimeoutFnOptions {
|
|
|
770
770
|
* @param interval
|
|
771
771
|
* @param immediate
|
|
772
772
|
*/
|
|
773
|
-
declare function useTimeoutFn(cb: (...args: unknown[]) => any, interval: MaybeComputedRef$1<number>, options?:
|
|
773
|
+
declare function useTimeoutFn(cb: (...args: unknown[]) => any, interval: MaybeComputedRef$1<number>, options?: UseTimeoutFnOptions): Stoppable;
|
|
774
774
|
|
|
775
|
-
interface
|
|
775
|
+
interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
|
|
776
776
|
/**
|
|
777
777
|
* Expose more controls
|
|
778
778
|
*
|
|
@@ -787,8 +787,8 @@ interface TimeoutOptions<Controls extends boolean> extends TimeoutFnOptions {
|
|
|
787
787
|
* @param interval
|
|
788
788
|
* @param immediate
|
|
789
789
|
*/
|
|
790
|
-
declare function useTimeout(interval?: number, options?:
|
|
791
|
-
declare function useTimeout(interval: number, options:
|
|
790
|
+
declare function useTimeout(interval?: number, options?: UseTimeoutOptions<false>): ComputedRef<boolean>;
|
|
791
|
+
declare function useTimeout(interval: number, options: UseTimeoutOptions<true>): {
|
|
792
792
|
ready: ComputedRef<boolean>;
|
|
793
793
|
} & Stoppable;
|
|
794
794
|
|
|
@@ -876,4 +876,4 @@ declare function watchTriggerable<T extends object, FnReturnT>(source: T, cb: Wa
|
|
|
876
876
|
*/
|
|
877
877
|
declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WatchOptions): vue_demi.WatchStopHandle;
|
|
878
878
|
|
|
879
|
-
export { ArgumentsType, Awaitable, ComputedRefWithControl, ComputedWithControlRefExtra, ConfigurableEventFilter, ConfigurableFlush, ConfigurableFlushSync, ControlledRefOptions, CreateGlobalStateReturn, DateLike, DebounceFilterOptions, DeepMaybeRef, ElementOf, EventFilter, EventHook, EventHookOff, EventHookOn, EventHookTrigger, ExtendRefOptions, Fn, FunctionArgs, FunctionWrapperOptions, IgnoredUpdater,
|
|
879
|
+
export { ArgumentsType, Awaitable, ComputedRefWithControl, ComputedWithControlRefExtra, ConfigurableEventFilter, ConfigurableFlush, ConfigurableFlushSync, ControlledRefOptions, CreateGlobalStateReturn, DateLike, DebounceFilterOptions, DeepMaybeRef, ElementOf, EventFilter, EventHook, EventHookOff, EventHookOn, EventHookTrigger, ExtendRefOptions, Fn, FunctionArgs, FunctionWrapperOptions, IgnoredUpdater, MapOldSources, MapSources, MaybeComputedRef, MaybeRef, Pausable, Reactified, ReactifyNested, ReactifyObjectOptions, ReactifyOptions, RemovableRef, RemoveableRef, ShallowUnwrapRef, SingletonPromiseReturn, Stopable, Stoppable, SyncRefOptions, SyncRefsOptions, UntilArrayInstance, UntilBaseInstance, UntilToMatchOptions, UntilValueInstance, UseArrayReducer, UseCounterOptions, UseDateFormatReturn, UseIntervalFnOptions, UseIntervalOptions, UseLastChangedOptions, UseTimeoutFnOptions, UseTimeoutOptions, UseToggleOptions, WatchArrayCallback, WatchAtMostOptions, WatchAtMostReturn, WatchDebouncedOptions, WatchIgnorableReturn, WatchPausableReturn, WatchThrottledOptions, WatchTriggerableCallback, WatchTriggerableReturn, WatchWithFilterOptions, WritableComputedRefWithControl, __onlyVue3, assert, refAutoReset as autoResetRef, bypassFilter, clamp, computedEager, computedWithControl, containsProp, computedWithControl as controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, reactify as createReactiveFn, createSharedComposable, createSingletonPromise, debounceFilter, refDebounced as debouncedRef, watchDebounced as debouncedWatch, directiveHooks, computedEager as eagerComputed, extendRef, formatDate, get, identity, watchIgnorable as ignorableWatch, increaseWithUnit, invoke, isBoolean, isClient, isDef, isDefined, isFunction, isIOS, isNumber, isObject, isString, isWindow, makeDestructurable, noop, normalizeDate, now, objectPick, pausableFilter, watchPausable as pausableWatch, promiseTimeout, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, set, syncRef, syncRefs, throttleFilter, refThrottled as throttledRef, watchThrottled as throttledWatch, timestamp, toReactive, toRefs, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayEvery, useArrayFilter, useArrayFind, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useCounter, useDateFormat, refDebounced as useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, refThrottled as useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToggle, watchArray, watchAtMost, watchDebounced, watchIgnorable, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };
|