@vueuse/shared 9.13.0 → 10.0.0-beta.0

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as vue_demi from 'vue-demi';
-import { WatchOptionsBase, Ref, ComputedRef, WritableComputedRef, WatchSource, ComputedGetter, WritableComputedOptions, ShallowUnwrapRef as ShallowUnwrapRef$1, WatchOptions, UnwrapRef, ToRefs, WatchCallback, WatchStopHandle } from 'vue-demi';
+import { WatchOptionsBase, Ref, ComputedRef, WritableComputedRef, WatchSource, ComputedGetter, WritableComputedOptions, WatchOptions, ShallowUnwrapRef as ShallowUnwrapRef$1, UnwrapRef, ToRefs, WatchCallback, WatchStopHandle } from 'vue-demi';
 
 declare function computedEager<T>(fn: () => T, options?: WatchOptionsBase): Readonly<Ref<T>>;
 
@@ -20,7 +20,7 @@ type EventHookOn<T = any> = (fn: (param: T) => void) => {
     off: () => void;
 };
 type EventHookOff<T = any> = (fn: (param: T) => void) => void;
-type EventHookTrigger<T = any> = (param: T) => void;
+type EventHookTrigger<T = any> = (param: T) => Promise<unknown[]>;
 interface EventHook<T = any> {
     on: EventHookOn<T>;
     off: EventHookOff<T>;
@@ -33,53 +33,6 @@ interface EventHook<T = any> {
  */
 declare function createEventHook<T = any>(): EventHook<T>;
 
-type CreateGlobalStateReturn<T> = () => T;
-/**
- * Keep states in the global scope to be reusable across Vue instances.
- *
- * @see https://vueuse.org/createGlobalState
- * @param stateFactory A factory function to create the state
- */
-declare function createGlobalState<T>(stateFactory: () => T): CreateGlobalStateReturn<T>;
-
-/**
- * Create global state that can be injected into components.
- *
- * @see https://vueuse.org/createInjectionState
- *
- */
-declare function createInjectionState<Arguments extends Array<any>, Return>(composable: (...args: Arguments) => Return): readonly [useProvidingState: (...args: Arguments) => Return, useInjectedState: () => Return | undefined];
-
-/**
- * Make a composable function usable with multiple Vue instances.
- *
- * @see https://vueuse.org/createSharedComposable
- */
-declare function createSharedComposable<Fn extends ((...args: any[]) => any)>(composable: Fn): Fn;
-
-interface ExtendRefOptions<Unwrap extends boolean = boolean> {
-    /**
-     * Is the extends properties enumerable
-     *
-     * @default false
-     */
-    enumerable?: boolean;
-    /**
-     * Unwrap for Ref properties
-     *
-     * @default true
-     */
-    unwrap?: Unwrap;
-}
-/**
- * Overload 1: Unwrap set to false
- */
-declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R, extend: Extend, options?: Options): ShallowUnwrapRef$1<Extend> & R;
-/**
- * Overload 2: Unwrap unset or set to true
- */
-declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R, extend: Extend, options?: Options): Extend & R;
-
 declare const isClient: boolean;
 declare const isDef: <T = any>(val?: T | undefined) => val is T;
 declare const assert: (condition: boolean, ...infos: any[]) => void;
@@ -112,10 +65,6 @@ type RemovableRef<T> = Omit<Ref<T>, 'value'> & {
     get value(): T;
     set value(value: T | null | undefined);
 };
-/**
- * @deprecated Use `RemovableRef`
- */
-type RemoveableRef<T> = RemovableRef<T>;
 /**
  * Maybe it's a ref, or a plain value
  *
@@ -189,10 +138,6 @@ interface Stoppable<StartFnArgs extends any[] = any[]> {
      */
     start: (...args: StartFnArgs) => void;
 }
-/**
- * @deprecated Use `Stoppable`
- */
-type Stopable = Stoppable;
 interface ConfigurableFlush {
     /**
      * Timing for monitoring changes, refer to WatchOptions for more details
@@ -324,6 +269,53 @@ declare function increaseWithUnit(target: string | number, delta: number): strin
  * @category Object
  */
 declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
+declare function objectEntries<T extends object>(obj: T): [keyof T, T[keyof T]][];
+
+/**
+ * Keep states in the global scope to be reusable across Vue instances.
+ *
+ * @see https://vueuse.org/createGlobalState
+ * @param stateFactory A factory function to create the state
+ */
+declare function createGlobalState<Fn extends AnyFn>(stateFactory: Fn): Fn;
+
+/**
+ * Create global state that can be injected into components.
+ *
+ * @see https://vueuse.org/createInjectionState
+ *
+ */
+declare function createInjectionState<Arguments extends Array<any>, Return>(composable: (...args: Arguments) => Return): readonly [useProvidingState: (...args: Arguments) => Return, useInjectedState: () => Return | undefined];
+
+/**
+ * Make a composable function usable with multiple Vue instances.
+ *
+ * @see https://vueuse.org/createSharedComposable
+ */
+declare function createSharedComposable<Fn extends AnyFn>(composable: Fn): Fn;
+
+interface ExtendRefOptions<Unwrap extends boolean = boolean> {
+    /**
+     * Is the extends properties enumerable
+     *
+     * @default false
+     */
+    enumerable?: boolean;
+    /**
+     * Unwrap for Ref properties
+     *
+     * @default true
+     */
+    unwrap?: Unwrap;
+}
+/**
+ * Overload 1: Unwrap set to false
+ */
+declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions<false>>(ref: R, extend: Extend, options?: Options): ShallowUnwrapRef$1<Extend> & R;
+/**
+ * Overload 2: Unwrap unset or set to true
+ */
+declare function extendRef<R extends Ref<any>, Extend extends object, Options extends ExtendRefOptions>(ref: R, extend: Extend, options?: Options): Extend & R;
 
 /**
  * Shorthand for accessing `ref.value`
@@ -358,7 +350,7 @@ interface ReactifyOptions<T extends boolean> {
 declare function reactify<T extends Function, K extends boolean = true>(fn: T, options?: ReactifyOptions<K>): Reactified<T, K>;
 
 type ReactifyNested<T, Keys extends keyof T = keyof T, S extends boolean = true> = {
-    [K in Keys]: T[K] extends (...args: any[]) => any ? Reactified<T[K], S> : T[K];
+    [K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S> : T[K];
 };
 interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
     /**
@@ -650,6 +642,9 @@ interface UntilArrayInstance<T> extends UntilBaseInstance<T> {
 declare function until<T extends unknown[]>(r: WatchSource<T> | MaybeComputedRef<T>): UntilArrayInstance<T>;
 declare function until<T>(r: WatchSource<T> | MaybeComputedRef<T>): UntilValueInstance<T>;
 
+declare function useArrayDifference<T>(list: MaybeComputedRef<T[]>, values: MaybeComputedRef<T[]>, key?: keyof T): ComputedRef<T[]>;
+declare function useArrayDifference<T>(list: MaybeComputedRef<T[]>, values: MaybeComputedRef<T[]>, compareFn?: (value: T, othVal: T) => boolean): ComputedRef<T[]>;
+
 /**
  * Reactive `Array.every`
  *
@@ -705,6 +700,15 @@ declare function useArrayFindIndex<T>(list: MaybeComputedRef<MaybeComputedRef<T>
  */
 declare function useArrayFindLast<T>(list: MaybeComputedRef<MaybeComputedRef<T>[]>, fn: (element: T, index: number, array: MaybeComputedRef<T>[]) => boolean): ComputedRef<T | undefined>;
 
+type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeComputedRef<T>[]) => boolean);
+interface UseArrayIncludesOptions<T, V> {
+    fromIndex?: number;
+    comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T;
+}
+declare function useArrayIncludes<T, V = any>(list: MaybeComputedRef<MaybeComputedRef<T>[]>, value: MaybeComputedRef<V>, comparator?: UseArrayIncludesComparatorFn<T, V>): ComputedRef<boolean>;
+declare function useArrayIncludes<T, V = any>(list: MaybeComputedRef<MaybeComputedRef<T>[]>, value: MaybeComputedRef<V>, comparator?: keyof T): ComputedRef<boolean>;
+declare function useArrayIncludes<T, V = any>(list: MaybeComputedRef<MaybeComputedRef<T>[]>, value: MaybeComputedRef<V>, options?: UseArrayIncludesOptions<T, V>): ComputedRef<boolean>;
+
 /**
  * Reactive `Array.join`
  *
@@ -928,7 +932,7 @@ interface UseTimeoutFnOptions {
  * @param interval
  * @param options
  */
-declare function useTimeoutFn<CallbackFn extends (...args: any[]) => any>(cb: CallbackFn, interval: MaybeComputedRef<number>, options?: UseTimeoutFnOptions): Stoppable<Parameters<CallbackFn> | []>;
+declare function useTimeoutFn<CallbackFn extends AnyFn>(cb: CallbackFn, interval: MaybeComputedRef<number>, options?: UseTimeoutFnOptions): Stoppable<Parameters<CallbackFn> | []>;
 
 interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
     /**
@@ -1023,6 +1027,13 @@ declare function watchDebounced<T extends Readonly<WatchSource<unknown>[]>, Imme
 declare function watchDebounced<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchDebouncedOptions<Immediate>): WatchStopHandle;
 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>): WatchStopHandle;
 
+/**
+ * Shorthand for watching value with {deep: true}
+ *
+ * @see https://vueuse.org/watchDeep
+ */
+declare function watchDeep<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WatchOptions): vue_demi.WatchStopHandle;
+
 type IgnoredUpdater = (updater: () => void) => void;
 interface WatchIgnorableReturn {
     ignoreUpdates: IgnoredUpdater;
@@ -1033,6 +1044,13 @@ declare function watchIgnorable<T extends Readonly<WatchSource<unknown>[]>, Imme
 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;
 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;
 
+/**
+ * Shorthand for watching value with {immediate: true}
+ *
+ * @see https://vueuse.org/watchImmediate
+ */
+declare function watchImmediate<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WatchOptions): vue_demi.WatchStopHandle;
+
 declare function watchOnce<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(source: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchOptions<Immediate>): void;
 declare function watchOnce<T, Immediate extends Readonly<boolean> = false>(sources: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate>): void;
 
@@ -1069,4 +1087,4 @@ declare function watchTriggerable<T extends object, FnReturnT>(source: T, cb: Wa
  */
 declare function whenever<T>(source: WatchSource<T | false | null | undefined>, cb: WatchCallback<T>, options?: WatchOptions): vue_demi.WatchStopHandle;
 
-export { AnyFn, ArgumentsType, Arrayable, 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, MaybeReadonlyRef, MaybeRef, Pausable, PromisifyFn, Reactified, ReactifyNested, ReactifyObjectOptions, ReactifyOptions, RemovableRef, RemoveableRef, ShallowUnwrapRef, SingletonPromiseReturn, Stopable, Stoppable, SyncRefOptions, SyncRefsOptions, UntilArrayInstance, UntilBaseInstance, UntilToMatchOptions, UntilValueInstance, UseArrayReducer, UseCounterOptions, UseDateFormatOptions, UseDateFormatReturn, UseIntervalControls, UseIntervalFnOptions, UseIntervalOptions, UseLastChangedOptions, UseTimeoutFnOptions, UseTimeoutOptions, UseToNumberOptions, UseToggleOptions, WatchArrayCallback, WatchAtMostOptions, WatchAtMostReturn, WatchDebouncedOptions, WatchIgnorableReturn, WatchPausableReturn, WatchThrottledOptions, WatchTriggerableCallback, WatchTriggerableReturn, WatchWithFilterOptions, WritableComputedRefWithControl, __onlyVue27Plus, __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, hasOwn, 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, useArrayFindIndex, useArrayFindLast, 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, watchIgnorable, watchOnce, watchPausable, watchThrottled, watchTriggerable, watchWithFilter, whenever };
+export { AnyFn, ArgumentsType, Arrayable, Awaitable, ComputedRefWithControl, ComputedWithControlRefExtra, ConfigurableEventFilter, ConfigurableFlush, ConfigurableFlushSync, ControlledRefOptions, DateLike, DebounceFilterOptions, DeepMaybeRef, ElementOf, EventFilter, EventHook, EventHookOff, EventHookOn, EventHookTrigger, ExtendRefOptions, Fn, FunctionArgs, FunctionWrapperOptions, IgnoredUpdater, MapOldSources, MapSources, MaybeComputedRef, MaybeReadonlyRef, MaybeRef, Pausable, PromisifyFn, Reactified, ReactifyNested, ReactifyObjectOptions, ReactifyOptions, RemovableRef, ShallowUnwrapRef, SingletonPromiseReturn, Stoppable, SyncRefOptions, SyncRefsOptions, UntilArrayInstance, UntilBaseInstance, UntilToMatchOptions, UntilValueInstance, UseArrayIncludesComparatorFn, UseArrayIncludesOptions, UseArrayReducer, UseCounterOptions, UseDateFormatOptions, UseDateFormatReturn, UseIntervalControls, UseIntervalFnOptions, UseIntervalOptions, UseLastChangedOptions, UseTimeoutFnOptions, UseTimeoutOptions, UseToNumberOptions, UseToggleOptions, WatchArrayCallback, WatchAtMostOptions, WatchAtMostReturn, WatchDebouncedOptions, WatchIgnorableReturn, WatchPausableReturn, WatchThrottledOptions, WatchTriggerableCallback, WatchTriggerableReturn, WatchWithFilterOptions, WritableComputedRefWithControl, __onlyVue27Plus, __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, hasOwn, identity, watchIgnorable as ignorableWatch, increaseWithUnit, invoke, isBoolean, isClient, isDef, isDefined, isFunction, isIOS, isNumber, isObject, isString, isWindow, makeDestructurable, noop, normalizeDate, now, objectEntries, 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, 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 };