feat(typedef): add return typedefs (#543)

packages/core/createGlobalState/index.md

@@ -43,6 +43,9 @@ export default defineComponent({
 export declare function createGlobalState<T extends object>(
   stateFactory: () => T
 ): () => T
+export declare type CreateGlobalStateReturn = ReturnType<
+  typeof createGlobalState
+>
 ```
 
 ## Source

packages/core/createGlobalState/index.ts

@@ -40,3 +40,5 @@ export function createGlobalState<T extends object>(
     return state
   }
 }
+
+export type CreateGlobalStateReturn = ReturnType<typeof createGlobalState>

packages/core/useAsyncState/index.md

@@ -82,6 +82,7 @@ export declare function useAsyncState<T>(
   >
   execute: (delay?: number) => Promise<void>
 }
+export declare type UseAsyncStateReturn = ReturnType<typeof useAsyncState>
 ```
 
 ## Source

packages/core/useAsyncState/index.ts

@@ -97,3 +97,5 @@ export function useAsyncState<T>(
     execute,
   }
 }
+
+export type UseAsyncStateReturn = ReturnType<typeof useAsyncState>

packages/core/useBattery/index.md

@@ -61,6 +61,7 @@ export declare function useBattery({ navigator }?: ConfigurableNavigator): {
   dischargingTime: Ref<number>
   level: Ref<number>
 }
+export declare type UseBatteryReturn = ReturnType<typeof useBattery>
 ```
 
 ## Source

packages/core/useBattery/index.ts

@@ -59,3 +59,5 @@ export function useBattery({ navigator = defaultNavigator }: ConfigurableNavigat
     level,
   }
 }
+
+export type UseBatteryReturn = ReturnType<typeof useBattery>

packages/core/useBreakpoints/index.md

@@ -55,6 +55,7 @@ export declare function useBreakpoints<K extends string>(
   isSmaller(k: K): boolean
   isInBetween(a: K, b: K): boolean
 }
+export declare type UseBreakpointsReturn = ReturnType<typeof useBreakpoints>
 ```
 
 ## Source

packages/core/useBreakpoints/index.ts

@@ -53,3 +53,5 @@ export function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, op
     },
   }
 }
+
+export type UseBreakpointsReturn = ReturnType<typeof useBreakpoints>

packages/core/useBrowserLocation/index.md

@@ -65,6 +65,9 @@ export declare function useBrowserLocation({
   protocol?: string | undefined
   search?: string | undefined
 }>
+export declare type UseBrowserLocationReturn = ReturnType<
+  typeof useBrowserLocation
+>
 ```
 
 ## Source

packages/core/useBrowserLocation/index.ts

@@ -55,3 +55,5 @@ export function useBrowserLocation({ window = defaultWindow }: ConfigurableWindo
 
   return state
 }
+
+export type UseBrowserLocationReturn = ReturnType<typeof useBrowserLocation>

packages/core/useDeviceMotion/index.md

@@ -59,6 +59,7 @@ export declare function useDeviceMotion(options?: DeviceMotionOptions): {
   rotationRate: Ref<DeviceMotionEventRotationRate | null>
   interval: Ref<number>
 }
+export declare type UseDeviceMotionReturn = ReturnType<typeof useDeviceMotion>
 ```
 
 ## Source

packages/core/useDeviceMotion/index.ts

@@ -49,3 +49,5 @@ export function useDeviceMotion(options: DeviceMotionOptions = {}) {
     interval,
   }
 }
+
+export type UseDeviceMotionReturn = ReturnType<typeof useDeviceMotion>

packages/core/useDeviceOrientation/index.md

@@ -58,6 +58,9 @@ export declare function useDeviceOrientation(options?: ConfigurableWindow): {
   beta: Ref<number | null>
   gamma: Ref<number | null>
 }
+export declare type UseDeviceOrientationReturn = ReturnType<
+  typeof useDeviceOrientation
+>
 ```
 
 ## Source

packages/core/useDeviceOrientation/index.ts

@@ -36,3 +36,5 @@ export function useDeviceOrientation(options: ConfigurableWindow = {}) {
     gamma,
   }
 }
+
+export type UseDeviceOrientationReturn = ReturnType<typeof useDeviceOrientation>

packages/core/useDevicePixelRatio/index.md

@@ -45,6 +45,9 @@ export default {
 export declare function useDevicePixelRatio({ window }?: ConfigurableWindow): {
   pixelRatio: Ref<number>
 }
+export declare type UseDevicePixelRatioReturn = ReturnType<
+  typeof useDevicePixelRatio
+>
 ```
 
 ## Source

packages/core/useDevicePixelRatio/index.ts

@@ -51,3 +51,5 @@ export function useDevicePixelRatio({
 
   return { pixelRatio }
 }
+
+export type UseDevicePixelRatioReturn = ReturnType<typeof useDevicePixelRatio>

packages/core/useElementBounding/index.md

@@ -67,6 +67,9 @@ export declare function useElementBounding(
   width: Ref<number>
   height: Ref<number>
 }
+export declare type UseElementBoundingReturn = ReturnType<
+  typeof useElementBounding
+>
 ```
 
 ## Source

packages/core/useElementBounding/index.ts

@@ -49,3 +49,5 @@ export function useElementBounding(
     height,
   }
 }
+
+export type UseElementBoundingReturn = ReturnType<typeof useElementBounding>

packages/core/useElementSize/index.md

@@ -71,6 +71,7 @@ export declare function useElementSize(
   width: Ref<number>
   height: Ref<number>
 }
+export declare type UseElementSizeReturn = ReturnType<typeof useElementSize>
 ```
 
 ## Source

packages/core/useElementSize/index.ts

@@ -37,3 +37,5 @@ export function useElementSize(
     height,
   }
 }
+
+export type UseElementSizeReturn = ReturnType<typeof useElementSize>

packages/core/useEventSource/index.md

@@ -48,6 +48,7 @@ export declare function useEventSource(
   error: Ref<Event | null>
   close: () => void
 }
+export declare type UseEventListenerReturn = ReturnType<typeof useEventListener>
 ```
 
 ## Source

packages/core/useEventSource/index.ts

@@ -66,3 +66,5 @@ export function useEventSource(url: string, events: Array<string> = []) {
     close,
   }
 }
+
+export type UseEventListenerReturn = ReturnType<typeof useEventListener>

packages/core/useFullscreen/index.md

@@ -61,6 +61,7 @@ export declare function useFullscreen(
   exit: () => Promise<void>
   toggle: () => Promise<void>
 }
+export declare type UseFullscreenReturn = ReturnType<typeof useFullscreen>
 ```
 
 ## Source

packages/core/useFullscreen/index.ts

@@ -135,3 +135,5 @@ export function useFullscreen(
     toggle,
   }
 }
+
+export type UseFullscreenReturn = ReturnType<typeof useFullscreen>

packages/core/useGeolocation/index.md

@@ -61,6 +61,7 @@ export declare function useGeolocation(options?: GeolocationOptions): {
     readonly TIMEOUT: number
   } | null>
 }
+export declare type UseGeolocationReturn = ReturnType<typeof useGeolocation>
 ```
 
 ## Source

packages/core/useGeolocation/index.ts

@@ -68,3 +68,5 @@ export function useGeolocation(options: GeolocationOptions = {}) {
     error,
   }
 }
+
+export type UseGeolocationReturn = ReturnType<typeof useGeolocation>

packages/core/useIdle/index.md

@@ -49,6 +49,10 @@ export interface IdleOptions
    */
   initialState?: boolean
 }
+export interface UseIdleReturn {
+  idle: Ref<boolean>
+  lastActive: Ref<number>
+}
 /**
  * Tracks whether the user is being inactive.
  *
@@ -59,10 +63,7 @@ export interface IdleOptions
 export declare function useIdle(
   timeout?: number,
   options?: IdleOptions
-): {
-  idle: Ref<boolean>
-  lastActive: Ref<number>
-}
+): UseIdleReturn
 ```
 
 ## Source

packages/core/useIdle/index.ts

@@ -1,5 +1,5 @@
-import { ref } from 'vue-demi'
 import { ConfigurableEventFilter, createFilterWrapper, throttleFilter, timestamp } from '@vueuse/shared'
+import { Ref, ref } from 'vue-demi'
 import { useEventListener, WindowEventName } from '../useEventListener'
 import { ConfigurableWindow, defaultWindow } from '../_configurable'
 
@@ -27,6 +27,11 @@ export interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter
   initialState?: boolean
 }
 
+export interface UseIdleReturn {
+  idle: Ref<boolean>
+  lastActive: Ref<number>
+}
+
 /**
  * Tracks whether the user is being inactive.
  *
@@ -37,7 +42,7 @@ export interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter
 export function useIdle(
   timeout: number = oneMinute,
   options: IdleOptions = {},
-) {
+): UseIdleReturn {
   const {
     initialState = false,
     listenForVisibilityChange = true,

packages/core/useIntersectionObserver/index.md

@@ -75,6 +75,9 @@ export declare function useIntersectionObserver(
   isSupported: boolean | undefined
   stop: () => void
 }
+export declare type UseIntersectionObserverReturn = ReturnType<
+  typeof useIntersectionObserver
+>
 ```
 
 ## Source

packages/core/useIntersectionObserver/index.ts

@@ -88,3 +88,5 @@ export function useIntersectionObserver(
     stop,
   }
 }
+
+export type UseIntersectionObserverReturn = ReturnType<typeof useIntersectionObserver>

packages/core/useMediaControls/index.md

@@ -495,6 +495,7 @@ export declare function useMediaControls(
   isPictureInPicture: Ref<boolean>
   onSourceError: EventHookOn<Event>
 }
+export declare type UseMediaControlsReturn = ReturnType<typeof useMediaControls>
 export {}
 ```
 

packages/core/useMediaControls/index.ts

@@ -469,3 +469,5 @@ export function useMediaControls(target: MaybeRef<HTMLMediaElement | null | unde
     onSourceError: sourceErrorEvent.on,
   }
 }
+
+export type UseMediaControlsReturn = ReturnType<typeof useMediaControls>

packages/core/useMouse/index.md

@@ -66,6 +66,7 @@ export declare function useMouse(options?: MouseOptions): {
   y: Ref<number>
   sourceType: Ref<MouseSourceType>
 }
+export declare type UseMouseReturn = ReturnType<typeof useMouse>
 ```
 
 ## Source

packages/core/useMouse/index.ts

@@ -76,3 +76,5 @@ export function useMouse(options: MouseOptions = {}) {
     sourceType,
   }
 }
+
+export type UseMouseReturn = ReturnType<typeof useMouse>

packages/core/useMouseInElement/index.md

@@ -70,6 +70,9 @@ export declare function useMouseInElement(
   isOutside: Ref<boolean>
   stop: () => void
 }
+export declare type UseMouseInElementReturn = ReturnType<
+  typeof useMouseInElement
+>
 ```
 
 ## Source

packages/core/useMouseInElement/index.ts

@@ -82,3 +82,5 @@ export function useMouseInElement(
     stop,
   }
 }
+
+export type UseMouseInElementReturn = ReturnType<typeof useMouseInElement>

packages/core/useMousePressed/index.md

@@ -92,6 +92,7 @@ export declare function useMousePressed(options?: MousePressedOptions): {
   pressed: Ref<boolean>
   sourceType: Ref<MouseSourceType>
 }
+export declare type UseMousePressedReturn = ReturnType<typeof useMousePressed>
 ```
 
 ## Source

packages/core/useMousePressed/index.ts

@@ -82,3 +82,5 @@ export function useMousePressed(options: MousePressedOptions = {}) {
     sourceType,
   }
 }
+
+export type UseMousePressedReturn = ReturnType<typeof useMousePressed>

packages/core/useMutationObserver/index.md

@@ -59,6 +59,9 @@ export declare function useMutationObserver(
   isSupported: boolean | undefined
   stop: () => void
 }
+export declare type UseMutationObserverReturn = ReturnType<
+  typeof useMutationObserver
+>
 ```
 
 ## Source

packages/core/useMutationObserver/index.ts

@@ -56,3 +56,5 @@ export function useMutationObserver(
     stop,
   }
 }
+
+export type UseMutationObserverReturn = ReturnType<typeof useMutationObserver>

packages/core/useNow/index.md

@@ -58,6 +58,7 @@ export declare function useNow(options?: UseNowOptions<false>): Ref<Date>
 export declare function useNow(options: UseNowOptions<true>): {
   now: Ref<Date>
 } & Pausable
+export declare type UseNowReturn = ReturnType<typeof useNow>
 ```
 
 ## Source

packages/core/useNow/index.ts

@@ -50,3 +50,5 @@ export function useNow(options: UseNowOptions<boolean> = {}) {
     return now
   }
 }
+
+export type UseNowReturn = ReturnType<typeof useNow>

packages/core/useResizeObserver/index.md

@@ -92,6 +92,9 @@ export declare function useResizeObserver(
   isSupported: boolean | undefined
   stop: () => void
 }
+export declare type UseResizeObserverReturn = ReturnType<
+  typeof useResizeObserver
+>
 export {}
 ```
 

packages/core/useResizeObserver/index.ts

@@ -86,3 +86,5 @@ export function useResizeObserver(
     stop,
   }
 }
+
+export type UseResizeObserverReturn = ReturnType<typeof useResizeObserver>

packages/core/useScriptTag/index.md

@@ -99,6 +99,7 @@ export declare function useScriptTag(
   load: (waitForScriptLoad?: boolean) => Promise<HTMLScriptElement | boolean>
   unload: () => void
 }
+export declare type UseScriptTagReturn = ReturnType<typeof useScriptTag>
 ```
 
 ## Source

packages/core/useScriptTag/index.ts

@@ -168,3 +168,5 @@ export function useScriptTag(
 
   return { scriptTag, load, unload }
 }
+
+export type UseScriptTagReturn = ReturnType<typeof useScriptTag>

packages/core/useShare/index.md

@@ -66,6 +66,7 @@ export declare function useShare(
   isSupported: boolean
   share: (overrideOptions?: MaybeRef<ShareOptions>) => Promise<void>
 }
+export declare type UseShareReturn = ReturnType<typeof useShare>
 ```
 
 ## Source

packages/core/useShare/index.ts

@@ -48,3 +48,5 @@ export function useShare(shareOptions: MaybeRef<ShareOptions> = {}, options: Con
     share,
   }
 }
+
+export type UseShareReturn = ReturnType<typeof useShare>