#useUserIdle

const { lastActive, isIdle, reset } = useUserIdle(timeout, options)

export interface UseUserIdleOptions {
  /**
   * Event names that listen to for detected user activity
   *
   * @defaultValue ['mousemove', 'mousedown', 'resize', 'keydown', 'touchstart', 'wheel']
   */
  events?: WindowEventName[]
  /**
   * Listen for document visibility change
   *
   * @defaultValue true
   */
  watchVisibility?: boolean
  /**
   * Initial state of the ref idle
   *
   * @defaultValue false
   */
  initialState?: boolean
  /**
   * Reset the idle state immediately
   *
   * @defaultValue true
   */
  immediate?: boolean
}

export interface UseUserIdleReturns extends Pausable<[reset?: boolean], [reset?: boolean]> {
  /**
   * Whether the user is idle
   */
  isIdle: boolean
  /**
   * The timestamp of the last user activity
   */
  lastActive: MutableRefObject<number>
  /**
   * Reset the idle state
   *
   * @param restart - Whether to restart the idle timer,`true` by default.
   */
  reset: (restart?: boolean) => void
}