aq-uiIntervalControls
interfaceSource L7Type contract for IntervalControls.
interface IntervalControlsMembers
| Name | Type |
|---|---|
pause | () => void |
resume | () => void |
isActive | boolean |
Use Interval
Open-code aq-ui React hook for Use Interval.
Installation
pnpm dlx aq-ui@alpha add use-intervalAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useInterval } from "@/hooks/use-interval"useInterval
functionSource L18Open-code aq-ui React hook for Use Interval.
function useInterval(callback: () => void, delay: number | null, { autoStart = true, immediate = false }: UseIntervalOptions = {}): IntervalControls- Returns
IntervalControls
Parameters
| Name | Type | Default |
|---|---|---|
callback | () => void | — |
delay | number | null | — |
options? | UseIntervalOptions | {} |
UseIntervalOptions
interfaceSource L13Type contract for UseIntervalOptions.
interface UseIntervalOptionsMembers
| Name | Type | Default |
|---|---|---|
autoStart? | boolean | true |
immediate? | boolean | false |
Registry dependencies
use-latest
Files
- hooks/use-interval.ts