fix(useIdle)!: rename type IdleOptions to UseIdleOptions (#1869)

vueuse · Jul 12, 2022 · 4ff5599 · 4ff5599
1 parent 5ef88c4
commit 4ff5599
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/core/useIdle/component.ts b/packages/core/useIdle/component.ts
@@ -1,8 +1,8 @@
 import { defineComponent, reactive } from 'vue-demi'
-import type { IdleOptions } from '@vueuse/core'
+import type { UseIdleOptions } from '@vueuse/core'
 import { useIdle } from '@vueuse/core'
 
-export const UseIdle = defineComponent<IdleOptions & { timeout: number }>({
+export const UseIdle = defineComponent<UseIdleOptions & { timeout: number }>({
   name: 'UseIdle',
   props: ['timeout', 'events', 'listenForVisibilityChange', 'initialState'] as unknown as undefined,
   setup(props, { slots }) {

diff --git a/packages/core/useIdle/index.ts b/packages/core/useIdle/index.ts
@@ -10,7 +10,7 @@ import { defaultWindow } from '../_configurable'
 const defaultEvents: WindowEventName[] = ['mousemove', 'mousedown', 'resize', 'keydown', 'touchstart', 'wheel']
 const oneMinute = 60_000
 
-export interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter {
+export interface UseIdleOptions extends ConfigurableWindow, ConfigurableEventFilter {
   /**
    * Event names that listen to for detected user activity
    *
@@ -45,7 +45,7 @@ export interface UseIdleReturn {
  */
 export function useIdle(
   timeout: number = oneMinute,
-  options: IdleOptions = {},
+  options: UseIdleOptions = {},
 ): UseIdleReturn {
   const {
     initialState = false,