useTimeout

Overview

A hook that handles the setTimeout timer function.

Documentation and Examples

Installation

pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useTimeout.json

npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useTimeout.json

yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useTimeout.json

bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useTimeout.json

A hook that handles the setTimeout timer function.

Examples

Default usage

API

useTimeout(
  fn: () => void,
  delay?: number | undefined
): fn: () => void;

Params

| Property | Description | Type | | -- | -- | | fn | The function to be executed after delay milliseconds. | () => void | | delay | The number of milliseconds to wait before executing the function. The timer will be cancelled if delay is undefined. | number | undefined |

Result

| Property | Description | Type | | | - | | | clearTimeout | clear timeout | () => void |