@vueuse/shared 12.5.0 → 12.6.0

package/index.cjs

@@ -9,13 +9,13 @@ function computedEager(fn, options) {
     result.value = fn();
   }, {
     ...options,
-    flush: (_a = options == null ? undefined : options.flush) != null ? _a : "sync"
+    flush: (_a = options == null ? void 0 : options.flush) != null ? _a : "sync"
   });
   return vue.readonly(result);
 }
 
 function computedWithControl(source, fn) {
-  let v = undefined;
+  let v = void 0;
   let track;
   let trigger;
   const dirty = vue.ref(true);
@@ -25,7 +25,7 @@ function computedWithControl(source, fn) {
   };
   vue.watch(source, update, { flush: "sync" });
   const get = typeof fn === "function" ? fn : fn.get;
-  const set = typeof fn === "function" ? undefined : fn.set;
+  const set = typeof fn === "function" ? void 0 : fn.set;
   const result = vue.customRef((_track, _trigger) => {
     track = _track;
     trigger = _trigger;
@@ -39,7 +39,7 @@ function computedWithControl(source, fn) {
         return v;
       },
       set(v2) {
-        set == null ? undefined : set(v2);
+        set == null ? void 0 : set(v2);
       }
     };
   });
@@ -101,7 +101,7 @@ const localProvidedStateMap = /* @__PURE__ */ new WeakMap();
 const injectLocal = (...args) => {
   var _a;
   const key = args[0];
-  const instance = (_a = vue.getCurrentInstance()) == null ? undefined : _a.proxy;
+  const instance = (_a = vue.getCurrentInstance()) == null ? void 0 : _a.proxy;
   if (instance == null && !vue.hasInjectionContext())
     throw new Error("injectLocal must be called in setup");
   if (instance && localProvidedStateMap.has(instance) && key in localProvidedStateMap.get(instance))
@@ -111,7 +111,7 @@ const injectLocal = (...args) => {
 
 const provideLocal = (key, value) => {
   var _a;
-  const instance = (_a = vue.getCurrentInstance()) == null ? undefined : _a.proxy;
+  const instance = (_a = vue.getCurrentInstance()) == null ? void 0 : _a.proxy;
   if (instance == null)
     throw new Error("provideLocal must be called in setup");
   if (!localProvidedStateMap.has(instance))
@@ -122,8 +122,8 @@ const provideLocal = (key, value) => {
 };
 
 function createInjectionState(composable, options) {
-  const key = (options == null ? undefined : options.injectionKey) || Symbol(composable.name || "InjectionState");
-  const defaultValue = options == null ? undefined : options.defaultValue;
+  const key = (options == null ? void 0 : options.injectionKey) || Symbol(composable.name || "InjectionState");
+  const defaultValue = options == null ? void 0 : options.defaultValue;
   const useProvidingState = (...args) => {
     const state = composable(...args);
     provideLocal(key, state);
@@ -141,8 +141,8 @@ function createSharedComposable(composable) {
     subscribers -= 1;
     if (scope && subscribers <= 0) {
       scope.stop();
-      state = undefined;
-      scope = undefined;
+      state = void 0;
+      scope = void 0;
     }
   };
   return (...args) => {
@@ -209,7 +209,7 @@ function makeDestructurable(obj, arr) {
 }
 
 function reactify(fn, options) {
-  const unrefFn = (options == null ? undefined : options.computedGetter) === false ? vue.unref : vue.toValue;
+  const unrefFn = (options == null ? void 0 : options.computedGetter) === false ? vue.unref : vue.toValue;
   return function(...args) {
     return vue.computed(() => fn.apply(this, args.map((i) => unrefFn(i))));
   };
@@ -305,7 +305,7 @@ const hasOwn = (val, key) => Object.prototype.hasOwnProperty.call(val, key);
 const isIOS = /* @__PURE__ */ getIsIOS();
 function getIsIOS() {
   var _a, _b;
-  return isClient && ((_a = window == null ? undefined : window.navigator) == null ? undefined : _a.userAgent) && (/iP(?:ad|hone|od)/.test(window.navigator.userAgent) || ((_b = window == null ? undefined : window.navigator) == null ? undefined : _b.maxTouchPoints) > 2 && /iPad|Macintosh/.test(window == null ? undefined : window.navigator.userAgent));
+  return isClient && ((_a = window == null ? void 0 : window.navigator) == null ? void 0 : _a.userAgent) && (/iP(?:ad|hone|od)/.test(window.navigator.userAgent) || ((_b = window == null ? void 0 : window.navigator) == null ? void 0 : _b.maxTouchPoints) > 2 && /iPad|Macintosh/.test(window == null ? void 0 : window.navigator.userAgent));
 }
 
 function createFilterWrapper(filter, fn) {
@@ -334,7 +334,7 @@ function debounceFilter(ms, options = {}) {
     const maxDuration = vue.toValue(options.maxWait);
     if (timer)
       _clearTimeout(timer);
-    if (duration <= 0 || maxDuration !== undefined && maxDuration <= 0) {
+    if (duration <= 0 || maxDuration !== void 0 && maxDuration <= 0) {
       if (maxTimer) {
         _clearTimeout(maxTimer);
         maxTimer = null;
@@ -379,7 +379,7 @@ function throttleFilter(...args) {
   const clear = () => {
     if (timer) {
       clearTimeout(timer);
-      timer = undefined;
+      timer = void 0;
       lastRejector();
       lastRejector = noop;
     }
@@ -416,8 +416,11 @@ function throttleFilter(...args) {
   };
   return filter;
 }
-function pausableFilter(extendFilter = bypassFilter) {
-  const isActive = vue.ref(true);
+function pausableFilter(extendFilter = bypassFilter, options = {}) {
+  const {
+    initialState = "active"
+  } = options;
+  const isActive = toRef(initialState === "active");
   function pause() {
     isActive.value = false;
   }
@@ -465,7 +468,7 @@ function createSingletonPromise(fn) {
   }
   wrapper.reset = async () => {
     const _prev = _promise;
-    _promise = undefined;
+    _promise = void 0;
     if (_prev)
       await _prev;
   };
@@ -481,7 +484,7 @@ function increaseWithUnit(target, delta) {
   var _a;
   if (typeof target === "number")
     return target + delta;
-  const value = ((_a = target.match(/^-?\d+\.?\d*/)) == null ? undefined : _a[0]) || "";
+  const value = ((_a = target.match(/^-?\d+\.?\d*/)) == null ? void 0 : _a[0]) || "";
   const unit = target.slice(value.length);
   const result = Number.parseFloat(value) + delta;
   if (Number.isNaN(result))
@@ -494,7 +497,7 @@ function pxValue(px) {
 function objectPick(obj, keys, omitUndefined = false) {
   return keys.reduce((n, k) => {
     if (k in obj) {
-      if (!omitUndefined || obj[k] !== undefined)
+      if (!omitUndefined || obj[k] !== void 0)
         n[k] = obj[k];
     }
     return n;
@@ -502,7 +505,7 @@ function objectPick(obj, keys, omitUndefined = false) {
 }
 function objectOmit(obj, keys, omitUndefined = false) {
   return Object.fromEntries(Object.entries(obj).filter(([key, value]) => {
-    return (!omitUndefined || value !== undefined) && !keys.includes(key);
+    return (!omitUndefined || value !== void 0) && !keys.includes(key);
   }));
 }
 function objectEntries(obj) {
@@ -627,10 +630,10 @@ function refWithControl(initial, options = {}) {
     if (value === source)
       return;
     const old = source;
-    if (((_a = options.onBeforeChange) == null ? undefined : _a.call(options, value, old)) === false)
+    if (((_a = options.onBeforeChange) == null ? void 0 : _a.call(options, value, old)) === false)
       return;
     source = value;
-    (_b = options.onChanged) == null ? undefined : _b.call(options, value, old);
+    (_b = options.onChanged) == null ? void 0 : _b.call(options, value, old);
     if (triggering)
       trigger();
   }
@@ -682,9 +685,10 @@ function watchWithFilter(source, cb, options = {}) {
 function watchPausable(source, cb, options = {}) {
   const {
     eventFilter: filter,
+    initialState = "active",
     ...watchOptions
   } = options;
-  const { eventFilter, pause, resume, isActive } = pausableFilter(filter);
+  const { eventFilter, pause, resume, isActive } = pausableFilter(filter, { initialState });
   const stop = watchWithFilter(
     source,
     cb,
@@ -826,7 +830,7 @@ function createUntil(r, isNot = false) {
             if (stop)
               stop();
             else
-              vue.nextTick(() => stop == null ? undefined : stop());
+              vue.nextTick(() => stop == null ? void 0 : stop());
             resolve(v);
           }
         },
@@ -840,7 +844,7 @@ function createUntil(r, isNot = false) {
     const promises = [watcher];
     if (timeout != null) {
       promises.push(
-        promiseTimeout(timeout, throwOnTimeout).then(() => vue.toValue(r)).finally(() => stop == null ? undefined : stop())
+        promiseTimeout(timeout, throwOnTimeout).then(() => vue.toValue(r)).finally(() => stop == null ? void 0 : stop())
       );
     }
     return Promise.race(promises);
@@ -858,7 +862,7 @@ function createUntil(r, isNot = false) {
             if (stop)
               stop();
             else
-              vue.nextTick(() => stop == null ? undefined : stop());
+              vue.nextTick(() => stop == null ? void 0 : stop());
             resolve(v1);
           }
         },
@@ -873,7 +877,7 @@ function createUntil(r, isNot = false) {
     if (timeout != null) {
       promises.push(
         promiseTimeout(timeout, throwOnTimeout).then(() => vue.toValue(r)).finally(() => {
-          stop == null ? undefined : stop();
+          stop == null ? void 0 : stop();
           return vue.toValue(r);
         })
       );
@@ -887,7 +891,7 @@ function createUntil(r, isNot = false) {
     return toBe(null, options);
   }
   function toBeUndefined(options) {
-    return toBe(undefined, options);
+    return toBe(void 0, options);
   }
   function toBeNaN(options) {
     return toMatch(Number.isNaN, options);
@@ -988,7 +992,7 @@ function findLast(arr, cb) {
     if (cb(arr[index], index, arr))
       return arr[index];
   }
-  return undefined;
+  return void 0;
 }
 function useArrayFindLast(list, fn) {
   return vue.computed(() => vue.toValue(
@@ -1078,7 +1082,7 @@ function useCounter(initialValue = 0, options = {}) {
 }
 
 const REGEX_PARSE = /^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[T\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/i;
-const REGEX_FORMAT = /[YMDHhms]o|\[([^\]]+)\]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a{1,2}|A{1,2}|m{1,2}|s{1,2}|Z{1,2}|SSS/g;
+const REGEX_FORMAT = /[YMDHhms]o|\[([^\]]+)\]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a{1,2}|A{1,2}|m{1,2}|s{1,2}|Z{1,2}|z{1,4}|SSS/g;
 function defaultMeridiem(hours, minutes, isLowercase, hasPeriod) {
   let m = hours < 12 ? "AM" : "PM";
   if (hasPeriod)
@@ -1101,6 +1105,10 @@ function formatDate(date, formatStr, options = {}) {
   const milliseconds = date.getMilliseconds();
   const day = date.getDay();
   const meridiem = (_a = options.customMeridiem) != null ? _a : defaultMeridiem;
+  const stripTimeZone = (dateString) => {
+    var _a2;
+    return (_a2 = dateString.split(" ")[1]) != null ? _a2 : "";
+  };
   const matches = {
     Yo: () => formatOrdinal(years),
     YY: () => String(years).slice(-2),
@@ -1133,17 +1141,21 @@ function formatDate(date, formatStr, options = {}) {
     A: () => meridiem(hours, minutes),
     AA: () => meridiem(hours, minutes, false, true),
     a: () => meridiem(hours, minutes, true),
-    aa: () => meridiem(hours, minutes, true, true)
+    aa: () => meridiem(hours, minutes, true, true),
+    z: () => stripTimeZone(date.toLocaleDateString(vue.toValue(options.locales), { timeZoneName: "shortOffset" })),
+    zz: () => stripTimeZone(date.toLocaleDateString(vue.toValue(options.locales), { timeZoneName: "shortOffset" })),
+    zzz: () => stripTimeZone(date.toLocaleDateString(vue.toValue(options.locales), { timeZoneName: "shortOffset" })),
+    zzzz: () => stripTimeZone(date.toLocaleDateString(vue.toValue(options.locales), { timeZoneName: "longOffset" }))
   };
   return formatStr.replace(REGEX_FORMAT, (match, $1) => {
     var _a2, _b;
-    return (_b = $1 != null ? $1 : (_a2 = matches[match]) == null ? undefined : _a2.call(matches)) != null ? _b : match;
+    return (_b = $1 != null ? $1 : (_a2 = matches[match]) == null ? void 0 : _a2.call(matches)) != null ? _b : match;
   });
 }
 function normalizeDate(date) {
   if (date === null)
     return new Date(Number.NaN);
-  if (date === undefined)
+  if (date === void 0)
     return /* @__PURE__ */ new Date();
   if (date instanceof Date)
     return new Date(date);
@@ -1249,7 +1261,8 @@ function useLastChanged(source, options = {}) {
 
 function useTimeoutFn(cb, interval, options = {}) {
   const {
-    immediate = true
+    immediate = true,
+    immediateCallback = false
   } = options;
   const isPending = vue.ref(false);
   let timer = null;
@@ -1264,6 +1277,8 @@ function useTimeoutFn(cb, interval, options = {}) {
     clear();
   }
   function start(...args) {
+    if (immediateCallback)
+      cb();
     clear();
     isPending.value = true;
     timer = setTimeout(() => {
@@ -1352,7 +1367,7 @@ function useToggle(initialValue = false, options = {}) {
 }
 
 function watchArray(source, cb, options) {
-  let oldList = (options == null ? undefined : options.immediate) ? [] : [...source instanceof Function ? source() : Array.isArray(source) ? source : vue.toValue(source)];
+  let oldList = (options == null ? void 0 : options.immediate) ? [] : [...source instanceof Function ? source() : Array.isArray(source) ? source : vue.toValue(source)];
   return vue.watch(source, (newList, _, onCleanup) => {
     const oldListRemains = Array.from({ length: oldList.length });
     const added = [];
@@ -1396,7 +1411,7 @@ function watchAtMost(source, cb, options) {
 function watchDebounced(source, cb, options = {}) {
   const {
     debounce = 0,
-    maxWait = undefined,
+    maxWait = void 0,
     ...watchOptions
   } = options;
   return watchWithFilter(
@@ -1533,7 +1548,7 @@ function watchTriggerable(source, cb, options = {}) {
     if (!cleanupFn)
       return;
     const fn = cleanupFn;
-    cleanupFn = undefined;
+    cleanupFn = void 0;
     fn();
   }
   function onCleanup(callback) {
@@ -1565,7 +1580,7 @@ function getWatchSources(sources) {
   return vue.toValue(sources);
 }
 function getOldValue(source) {
-  return Array.isArray(source) ? source.map(() => undefined) : undefined;
+  return Array.isArray(source) ? source.map(() => void 0) : void 0;
 }
 
 function whenever(source, cb, options) {
@@ -1573,7 +1588,7 @@ function whenever(source, cb, options) {
     source,
     (v, ov, onInvalidate) => {
       if (v) {
-        if (options == null ? undefined : options.once)
+        if (options == null ? void 0 : options.once)
           vue.nextTick(() => stop());
         cb(v, ov, onInvalidate);
       }

package/index.d.cts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { WatchOptionsBase, Ref, ComputedRef, WritableComputedRef, WatchSource, ComputedGetter, WritableComputedOptions, MaybeRef, WatchOptions, MaybeRefOrGetter, InjectionKey, ShallowUnwrapRef as ShallowUnwrapRef$1, inject, provide, UnwrapNestedRefs, UnwrapRef, ToRef, ToRefs, toValue as toValue$1, WatchCallback, WatchStopHandle } from 'vue';
+import { WatchOptionsBase, Ref, WatchSource, ComputedGetter, ComputedRef, WritableComputedOptions, WritableComputedRef, WatchOptions, MaybeRef, MaybeRefOrGetter, InjectionKey, ShallowUnwrapRef as ShallowUnwrapRef$1, inject, provide, UnwrapNestedRefs, UnwrapRef, ToRef, ToRefs, toValue as toValue$1, WatchCallback, WatchStopHandle } from 'vue';
 export { MaybeRef, MaybeRefOrGetter } from 'vue';
 
 /**
@@ -142,12 +142,12 @@ type IsAny<T> = IfAny<T, true, false>;
 
 type Callback<T> = IsAny<T> extends true ? (...param: any) => void : ([
     T
-] extends [void] ? (...param: unknown[]) => void : (...param: [T, ...unknown[]]) => void);
+] extends [void] ? (...param: unknown[]) => void : [T] extends [any[]] ? (...param: T) => void : (...param: [T, ...unknown[]]) => void);
 type EventHookOn<T = any> = (fn: Callback<T>) => {
     off: () => void;
 };
 type EventHookOff<T = any> = (fn: Callback<T>) => void;
-type EventHookTrigger<T = any> = (...param: IsAny<T> extends true ? unknown[] : [T, ...unknown[]]) => Promise<unknown[]>;
+type EventHookTrigger<T = any> = (...param: Parameters<Callback<T>>) => Promise<unknown[]>;
 interface EventHook<T = any> {
     on: EventHookOn<T>;
     off: EventHookOff<T>;
@@ -226,13 +226,21 @@ interface ThrottleFilterOptions {
  */
 declare function throttleFilter(ms: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): EventFilter;
 declare function throttleFilter(options: ThrottleFilterOptions): EventFilter;
+interface PausableFilterOptions {
+    /**
+     * The initial state
+     *
+     * @default 'active'
+     */
+    initialState?: 'active' | 'paused';
+}
 /**
  * EventFilter that gives extra controls to pause and resume the filter
  *
  * @param extendFilter  Extra filter to apply when the PausableFilter is active, default to none
- *
+ * @param options Options to configure the filter
  */
-declare function pausableFilter(extendFilter?: EventFilter): Pausable & {
+declare function pausableFilter(extendFilter?: EventFilter, options?: PausableFilterOptions): Pausable & {
     eventFilter: EventFilter;
 };
 
@@ -433,7 +441,7 @@ declare function reactifyObject<T extends object, S extends boolean = true>(obj:
 /**
  * Computed reactive object.
  */
-declare function reactiveComputed<T extends object>(fn: () => T): UnwrapNestedRefs<T>;
+declare function reactiveComputed<T extends object>(fn: ComputedGetter<T>): UnwrapNestedRefs<T>;
 
 type ReactiveOmitPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
 declare function reactiveOmit<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): Omit<T, K>;
@@ -1051,11 +1059,17 @@ declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGet
 
 interface UseTimeoutFnOptions {
     /**
-     * Start the timer immediate after calling this function
+     * Start the timer immediately
      *
      * @default true
      */
     immediate?: boolean;
+    /**
+     * Execute the callback immediately after calling `start`
+     *
+     * @default false
+     */
+    immediateCallback?: boolean;
 }
 /**
  * Wrapper for `setTimeout` with controls.
@@ -1185,9 +1199,10 @@ declare function watchOnce<T, Immediate extends Readonly<boolean> = false>(sourc
 interface WatchPausableReturn extends Pausable {
     stop: WatchStopHandle;
 }
-declare function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
-declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
-declare function watchPausable<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
+type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
+declare function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
+declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
+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;
 
 interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
     throttle?: MaybeRefOrGetter<number>;
@@ -1225,4 +1240,4 @@ interface WheneverOptions extends WatchOptions {
  */
 declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions): vue.WatchHandle;
 
-export { type AnyFn, type ArgumentsType, type Arrayable, type Awaitable, type Awaited, type ComputedRefWithControl, type ComputedWithControlRefExtra, type ConfigurableEventFilter, type ConfigurableFlush, type ConfigurableFlushSync, type ControlledRefOptions, type CreateInjectionStateOptions, type DateLike, type DebounceFilterOptions, type DeepMaybeRef, type ElementOf, type EventFilter, type EventHook, type EventHookOff, type EventHookOn, type EventHookTrigger, type ExtendRefOptions, type Fn, type FunctionArgs, type FunctionWrapperOptions, type IfAny, type IgnoredUpdater, type IsAny, type MapOldSources, type MapSources, type MultiWatchSources, type Mutable, type Pausable, type Promisify, type PromisifyFn, type Reactified, type ReactifyNested, type ReactifyObjectOptions, type ReactifyOptions, type ReactiveOmitPredicate, type ReactivePickPredicate, type ReadonlyRefOrGetter, type RemovableRef, type ShallowUnwrapRef, type SingletonPromiseReturn, type Stoppable, type SyncRefOptions, type SyncRefsOptions, type ThrottleFilterOptions, type ToRefsOptions, type UntilArrayInstance, type UntilBaseInstance, type UntilToMatchOptions, type UntilValueInstance, type UseArrayDifferenceOptions, type UseArrayIncludesComparatorFn, type UseArrayIncludesOptions, type UseArrayReducer, type UseCounterOptions, type UseDateFormatOptions, type UseDateFormatReturn, type UseIntervalControls, type UseIntervalFnOptions, type UseIntervalOptions, type UseLastChangedOptions, type UseTimeoutFnOptions, type UseTimeoutOptions, type UseToNumberOptions, type UseToggleOptions, type WatchArrayCallback, type WatchAtMostOptions, type WatchAtMostReturn, type WatchDebouncedOptions, type WatchIgnorableReturn, type WatchPausableReturn, type WatchThrottledOptions, type WatchTriggerableCallback, type WatchTriggerableReturn, type WatchWithFilterOptions, type WheneverOptions, type WritableComputedRefWithControl, assert, refAutoReset as autoResetRef, bypassFilter, camelize, clamp, computedEager, computedWithControl, containsProp, computedWithControl as controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, reactify as createReactiveFn, createSharedComposable, createSingletonPromise, debounceFilter, refDebounced as debouncedRef, watchDebounced as debouncedWatch, computedEager as eagerComputed, extendRef, formatDate, get, getLifeCycleTarget, hasOwn, hyphenate, identity, watchIgnorable as ignorableWatch, increaseWithUnit, injectLocal, invoke, isClient, isDef, isDefined, isIOS, isObject, isWorker, makeDestructurable, noop, normalizeDate, notNullish, now, objectEntries, objectOmit, objectPick, pausableFilter, watchPausable as pausableWatch, promiseTimeout, provideLocal, pxValue, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, set, syncRef, syncRefs, throttleFilter, refThrottled as throttledRef, watchThrottled as throttledWatch, timestamp, toArray, toReactive, toRef, toRefs, toValue, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayFindLast, useArrayIncludes, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useCounter, useDateFormat, refDebounced as useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, refThrottled as useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, useToggle, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };
+export { type AnyFn, type ArgumentsType, type Arrayable, type Awaitable, type Awaited, type ComputedRefWithControl, type ComputedWithControlRefExtra, type ConfigurableEventFilter, type ConfigurableFlush, type ConfigurableFlushSync, type ControlledRefOptions, type CreateInjectionStateOptions, type DateLike, type DebounceFilterOptions, type DeepMaybeRef, type ElementOf, type EventFilter, type EventHook, type EventHookOff, type EventHookOn, type EventHookTrigger, type ExtendRefOptions, type Fn, type FunctionArgs, type FunctionWrapperOptions, type IfAny, type IgnoredUpdater, type IsAny, type MapOldSources, type MapSources, type MultiWatchSources, type Mutable, type Pausable, type PausableFilterOptions, type Promisify, type PromisifyFn, type Reactified, type ReactifyNested, type ReactifyObjectOptions, type ReactifyOptions, type ReactiveOmitPredicate, type ReactivePickPredicate, type ReadonlyRefOrGetter, type RemovableRef, type ShallowUnwrapRef, type SingletonPromiseReturn, type Stoppable, type SyncRefOptions, type SyncRefsOptions, type ThrottleFilterOptions, type ToRefsOptions, type UntilArrayInstance, type UntilBaseInstance, type UntilToMatchOptions, type UntilValueInstance, type UseArrayDifferenceOptions, type UseArrayIncludesComparatorFn, type UseArrayIncludesOptions, type UseArrayReducer, type UseCounterOptions, type UseDateFormatOptions, type UseDateFormatReturn, type UseIntervalControls, type UseIntervalFnOptions, type UseIntervalOptions, type UseLastChangedOptions, type UseTimeoutFnOptions, type UseTimeoutOptions, type UseToNumberOptions, type UseToggleOptions, type WatchArrayCallback, type WatchAtMostOptions, type WatchAtMostReturn, type WatchDebouncedOptions, type WatchIgnorableReturn, type WatchPausableOptions, type WatchPausableReturn, type WatchThrottledOptions, type WatchTriggerableCallback, type WatchTriggerableReturn, type WatchWithFilterOptions, type WheneverOptions, type WritableComputedRefWithControl, assert, refAutoReset as autoResetRef, bypassFilter, camelize, clamp, computedEager, computedWithControl, containsProp, computedWithControl as controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, reactify as createReactiveFn, createSharedComposable, createSingletonPromise, debounceFilter, refDebounced as debouncedRef, watchDebounced as debouncedWatch, computedEager as eagerComputed, extendRef, formatDate, get, getLifeCycleTarget, hasOwn, hyphenate, identity, watchIgnorable as ignorableWatch, increaseWithUnit, injectLocal, invoke, isClient, isDef, isDefined, isIOS, isObject, isWorker, makeDestructurable, noop, normalizeDate, notNullish, now, objectEntries, objectOmit, objectPick, pausableFilter, watchPausable as pausableWatch, promiseTimeout, provideLocal, pxValue, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, set, syncRef, syncRefs, throttleFilter, refThrottled as throttledRef, watchThrottled as throttledWatch, timestamp, toArray, toReactive, toRef, toRefs, toValue, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayFindLast, useArrayIncludes, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useCounter, useDateFormat, refDebounced as useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, refThrottled as useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, useToggle, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };

package/index.d.mts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { WatchOptionsBase, Ref, ComputedRef, WritableComputedRef, WatchSource, ComputedGetter, WritableComputedOptions, MaybeRef, WatchOptions, MaybeRefOrGetter, InjectionKey, ShallowUnwrapRef as ShallowUnwrapRef$1, inject, provide, UnwrapNestedRefs, UnwrapRef, ToRef, ToRefs, toValue as toValue$1, WatchCallback, WatchStopHandle } from 'vue';
+import { WatchOptionsBase, Ref, WatchSource, ComputedGetter, ComputedRef, WritableComputedOptions, WritableComputedRef, WatchOptions, MaybeRef, MaybeRefOrGetter, InjectionKey, ShallowUnwrapRef as ShallowUnwrapRef$1, inject, provide, UnwrapNestedRefs, UnwrapRef, ToRef, ToRefs, toValue as toValue$1, WatchCallback, WatchStopHandle } from 'vue';
 export { MaybeRef, MaybeRefOrGetter } from 'vue';
 
 /**
@@ -142,12 +142,12 @@ type IsAny<T> = IfAny<T, true, false>;
 
 type Callback<T> = IsAny<T> extends true ? (...param: any) => void : ([
     T
-] extends [void] ? (...param: unknown[]) => void : (...param: [T, ...unknown[]]) => void);
+] extends [void] ? (...param: unknown[]) => void : [T] extends [any[]] ? (...param: T) => void : (...param: [T, ...unknown[]]) => void);
 type EventHookOn<T = any> = (fn: Callback<T>) => {
     off: () => void;
 };
 type EventHookOff<T = any> = (fn: Callback<T>) => void;
-type EventHookTrigger<T = any> = (...param: IsAny<T> extends true ? unknown[] : [T, ...unknown[]]) => Promise<unknown[]>;
+type EventHookTrigger<T = any> = (...param: Parameters<Callback<T>>) => Promise<unknown[]>;
 interface EventHook<T = any> {
     on: EventHookOn<T>;
     off: EventHookOff<T>;
@@ -226,13 +226,21 @@ interface ThrottleFilterOptions {
  */
 declare function throttleFilter(ms: MaybeRefOrGetter<number>, trailing?: boolean, leading?: boolean, rejectOnCancel?: boolean): EventFilter;
 declare function throttleFilter(options: ThrottleFilterOptions): EventFilter;
+interface PausableFilterOptions {
+    /**
+     * The initial state
+     *
+     * @default 'active'
+     */
+    initialState?: 'active' | 'paused';
+}
 /**
  * EventFilter that gives extra controls to pause and resume the filter
  *
  * @param extendFilter  Extra filter to apply when the PausableFilter is active, default to none
- *
+ * @param options Options to configure the filter
  */
-declare function pausableFilter(extendFilter?: EventFilter): Pausable & {
+declare function pausableFilter(extendFilter?: EventFilter, options?: PausableFilterOptions): Pausable & {
     eventFilter: EventFilter;
 };
 
@@ -433,7 +441,7 @@ declare function reactifyObject<T extends object, S extends boolean = true>(obj:
 /**
  * Computed reactive object.
  */
-declare function reactiveComputed<T extends object>(fn: () => T): UnwrapNestedRefs<T>;
+declare function reactiveComputed<T extends object>(fn: ComputedGetter<T>): UnwrapNestedRefs<T>;
 
 type ReactiveOmitPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
 declare function reactiveOmit<T extends object, K extends keyof T>(obj: T, ...keys: (K | K[])[]): Omit<T, K>;
@@ -1051,11 +1059,17 @@ declare function useThrottleFn<T extends FunctionArgs>(fn: T, ms?: MaybeRefOrGet
 
 interface UseTimeoutFnOptions {
     /**
-     * Start the timer immediate after calling this function
+     * Start the timer immediately
      *
      * @default true
      */
     immediate?: boolean;
+    /**
+     * Execute the callback immediately after calling `start`
+     *
+     * @default false
+     */
+    immediateCallback?: boolean;
 }
 /**
  * Wrapper for `setTimeout` with controls.
@@ -1185,9 +1199,10 @@ declare function watchOnce<T, Immediate extends Readonly<boolean> = false>(sourc
 interface WatchPausableReturn extends Pausable {
     stop: WatchStopHandle;
 }
-declare function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
-declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
-declare function watchPausable<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchWithFilterOptions<Immediate>): WatchPausableReturn;
+type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;
+declare function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
+declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn;
+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;
 
 interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
     throttle?: MaybeRefOrGetter<number>;
@@ -1225,4 +1240,4 @@ interface WheneverOptions extends WatchOptions {
  */
 declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WheneverOptions): vue.WatchHandle;
 
-export { type AnyFn, type ArgumentsType, type Arrayable, type Awaitable, type Awaited, type ComputedRefWithControl, type ComputedWithControlRefExtra, type ConfigurableEventFilter, type ConfigurableFlush, type ConfigurableFlushSync, type ControlledRefOptions, type CreateInjectionStateOptions, type DateLike, type DebounceFilterOptions, type DeepMaybeRef, type ElementOf, type EventFilter, type EventHook, type EventHookOff, type EventHookOn, type EventHookTrigger, type ExtendRefOptions, type Fn, type FunctionArgs, type FunctionWrapperOptions, type IfAny, type IgnoredUpdater, type IsAny, type MapOldSources, type MapSources, type MultiWatchSources, type Mutable, type Pausable, type Promisify, type PromisifyFn, type Reactified, type ReactifyNested, type ReactifyObjectOptions, type ReactifyOptions, type ReactiveOmitPredicate, type ReactivePickPredicate, type ReadonlyRefOrGetter, type RemovableRef, type ShallowUnwrapRef, type SingletonPromiseReturn, type Stoppable, type SyncRefOptions, type SyncRefsOptions, type ThrottleFilterOptions, type ToRefsOptions, type UntilArrayInstance, type UntilBaseInstance, type UntilToMatchOptions, type UntilValueInstance, type UseArrayDifferenceOptions, type UseArrayIncludesComparatorFn, type UseArrayIncludesOptions, type UseArrayReducer, type UseCounterOptions, type UseDateFormatOptions, type UseDateFormatReturn, type UseIntervalControls, type UseIntervalFnOptions, type UseIntervalOptions, type UseLastChangedOptions, type UseTimeoutFnOptions, type UseTimeoutOptions, type UseToNumberOptions, type UseToggleOptions, type WatchArrayCallback, type WatchAtMostOptions, type WatchAtMostReturn, type WatchDebouncedOptions, type WatchIgnorableReturn, type WatchPausableReturn, type WatchThrottledOptions, type WatchTriggerableCallback, type WatchTriggerableReturn, type WatchWithFilterOptions, type WheneverOptions, type WritableComputedRefWithControl, assert, refAutoReset as autoResetRef, bypassFilter, camelize, clamp, computedEager, computedWithControl, containsProp, computedWithControl as controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, reactify as createReactiveFn, createSharedComposable, createSingletonPromise, debounceFilter, refDebounced as debouncedRef, watchDebounced as debouncedWatch, computedEager as eagerComputed, extendRef, formatDate, get, getLifeCycleTarget, hasOwn, hyphenate, identity, watchIgnorable as ignorableWatch, increaseWithUnit, injectLocal, invoke, isClient, isDef, isDefined, isIOS, isObject, isWorker, makeDestructurable, noop, normalizeDate, notNullish, now, objectEntries, objectOmit, objectPick, pausableFilter, watchPausable as pausableWatch, promiseTimeout, provideLocal, pxValue, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, set, syncRef, syncRefs, throttleFilter, refThrottled as throttledRef, watchThrottled as throttledWatch, timestamp, toArray, toReactive, toRef, toRefs, toValue, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayFindLast, useArrayIncludes, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useCounter, useDateFormat, refDebounced as useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, refThrottled as useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, useToggle, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };
+export { type AnyFn, type ArgumentsType, type Arrayable, type Awaitable, type Awaited, type ComputedRefWithControl, type ComputedWithControlRefExtra, type ConfigurableEventFilter, type ConfigurableFlush, type ConfigurableFlushSync, type ControlledRefOptions, type CreateInjectionStateOptions, type DateLike, type DebounceFilterOptions, type DeepMaybeRef, type ElementOf, type EventFilter, type EventHook, type EventHookOff, type EventHookOn, type EventHookTrigger, type ExtendRefOptions, type Fn, type FunctionArgs, type FunctionWrapperOptions, type IfAny, type IgnoredUpdater, type IsAny, type MapOldSources, type MapSources, type MultiWatchSources, type Mutable, type Pausable, type PausableFilterOptions, type Promisify, type PromisifyFn, type Reactified, type ReactifyNested, type ReactifyObjectOptions, type ReactifyOptions, type ReactiveOmitPredicate, type ReactivePickPredicate, type ReadonlyRefOrGetter, type RemovableRef, type ShallowUnwrapRef, type SingletonPromiseReturn, type Stoppable, type SyncRefOptions, type SyncRefsOptions, type ThrottleFilterOptions, type ToRefsOptions, type UntilArrayInstance, type UntilBaseInstance, type UntilToMatchOptions, type UntilValueInstance, type UseArrayDifferenceOptions, type UseArrayIncludesComparatorFn, type UseArrayIncludesOptions, type UseArrayReducer, type UseCounterOptions, type UseDateFormatOptions, type UseDateFormatReturn, type UseIntervalControls, type UseIntervalFnOptions, type UseIntervalOptions, type UseLastChangedOptions, type UseTimeoutFnOptions, type UseTimeoutOptions, type UseToNumberOptions, type UseToggleOptions, type WatchArrayCallback, type WatchAtMostOptions, type WatchAtMostReturn, type WatchDebouncedOptions, type WatchIgnorableReturn, type WatchPausableOptions, type WatchPausableReturn, type WatchThrottledOptions, type WatchTriggerableCallback, type WatchTriggerableReturn, type WatchWithFilterOptions, type WheneverOptions, type WritableComputedRefWithControl, assert, refAutoReset as autoResetRef, bypassFilter, camelize, clamp, computedEager, computedWithControl, containsProp, computedWithControl as controlledComputed, controlledRef, createEventHook, createFilterWrapper, createGlobalState, createInjectionState, reactify as createReactiveFn, createSharedComposable, createSingletonPromise, debounceFilter, refDebounced as debouncedRef, watchDebounced as debouncedWatch, computedEager as eagerComputed, extendRef, formatDate, get, getLifeCycleTarget, hasOwn, hyphenate, identity, watchIgnorable as ignorableWatch, increaseWithUnit, injectLocal, invoke, isClient, isDef, isDefined, isIOS, isObject, isWorker, makeDestructurable, noop, normalizeDate, notNullish, now, objectEntries, objectOmit, objectPick, pausableFilter, watchPausable as pausableWatch, promiseTimeout, provideLocal, pxValue, rand, reactify, reactifyObject, reactiveComputed, reactiveOmit, reactivePick, refAutoReset, refDebounced, refDefault, refThrottled, refWithControl, resolveRef, resolveUnref, set, syncRef, syncRefs, throttleFilter, refThrottled as throttledRef, watchThrottled as throttledWatch, timestamp, toArray, toReactive, toRef, toRefs, toValue, tryOnBeforeMount, tryOnBeforeUnmount, tryOnMounted, tryOnScopeDispose, tryOnUnmounted, until, useArrayDifference, useArrayEvery, useArrayFilter, useArrayFind, useArrayFindIndex, useArrayFindLast, useArrayIncludes, useArrayJoin, useArrayMap, useArrayReduce, useArraySome, useArrayUnique, useCounter, useDateFormat, refDebounced as useDebounce, useDebounceFn, useInterval, useIntervalFn, useLastChanged, refThrottled as useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useToNumber, useToString, useToggle, watchArray, watchAtMost, watchDebounced, watchDeep, watchIgnorable, watchImmediate, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };