⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	3
📦 Imports	6
📐 Interfaces	2
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/useInterval/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
ShallowRef	vue
Pausable	../utils
shallowReadonly	vue
shallowRef	vue
useIntervalFn	../useIntervalFn

---

Functions

useInterval(interval: MaybeRefOrGetter<number>, options: UseIntervalOptions<false>): Readonly<ShallowRef<number>>

Code

export function useInterval(interval?: MaybeRefOrGetter<number>, options?: UseIntervalOptions<false>): Readonly<ShallowRef<number>>

• JSDoc:

  /**
   * Reactive counter increases on every interval
   *
   * @see https://vueuse.org/useInterval
   * @param interval
   * @param options
   */
  

• Parameters:

• interval: MaybeRefOrGetter<number>
• options: UseIntervalOptions<false>
• Return Type: Readonly<ShallowRef<number>>

update(): any

Code

() => counter.value += 1

• Return Type: any

reset(): void

Code

() => {
    counter.value = 0
  }

• Return Type: void

---

Interfaces

UseIntervalOptions<Controls extends boolean>

Interface Code

export interface UseIntervalOptions<Controls extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls

  /**
   * Execute the update immediately on calling
   *
   * @default true
   */
  immediate?: boolean

  /**
   * Callback on every interval
   */
  callback?: (count: number) => void
}

Properties

Name	Type	Optional	Description
controls	Controls	✓
immediate	boolean	✓
callback	(count: number) => void	✓

UseIntervalControls

Interface Code

export interface UseIntervalControls {
  counter: ShallowRef<number>
  reset: () => void
}

Properties

Name	Type	Optional	Description
counter	ShallowRef<number>	✗
reset	() => void	✗

---

Type Aliases

UseIntervalReturn

type UseIntervalReturn = Readonly<ShallowRef<number>> | Readonly<UseIntervalControls & Pausable>;

---