@rooks/use-timeout

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

``
npm install rooks
`

or

`
yarn add rooks
`

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

!TitleCard

!Build Status![](https://img.shields.io/npm/v/@rooks/use-timeout/latest.svg) ![](https://img.shields.io/npm/l/@rooks/use-timeout.svg) ![](https://img.shields.io/npm/dt/@rooks/use-timeout.svg) ![](https://img.shields.io/david/imbhargav5/rooks.svg?path=packages%2Ftimeout)

About

`
npm install --save @rooks/use-timeout
`

Importing the hook

`javascript
import useTimeout from "@rooks/use-timeout"
`

Usage

`jsx
function TimeoutComponent() {
function doAlert() {
window.alert("timeout expired!");
}
const { start, clear } = useTimeout(doAlert, 2000);
return (
<>
Start timeout
Clear timeout

);
}

render()
``

$3

| Arguments | Type | Description | Default value |
| --------- | -------- | -------------------------------------------------------- | ------------- |
| callback | function | Function to be executed in timeout | undefind |
| delay | Number | Number in milliseconds after which callback is to be run | 0 |

$3

| Returned object attributes | Type | Description |
| -------------------------- | -------- | --------------------- |
| clear | function | Clear the timeout |
| start | function | Start the timeout |
| isActive | boolean | Is the timeout active |