

Custom hook that manages countdown.

## Usage [#usage]

```tsx
import { useCountdown } from "@tilt-legal/cubitt-components/utilities/hooks";

const [counter, { start, stop, reset }] = useCountdown({
  countStart: 10,
  intervalMs: 1000,
  isIncrement: false,
});
```

## API [#api]

### Signature [#signature]

```ts
declare function useCountdown({ countStart, countStop, intervalMs, isIncrement, }: CountdownOptions): [number, CountdownControllers];
```

### Parameters [#parameters]

| Parameter          | Type               | Description              | Default |
| ------------------ | ------------------ | ------------------------ | ------- |
| `countdownOptions` | `CountdownOptions` | The countdown's options. | -       |

### Return Value [#return-value]

| Value    | Type                             | Description                                                    |
| -------- | -------------------------------- | -------------------------------------------------------------- |
| `return` | `[number, CountdownControllers]` | An array containing the countdown's count and its controllers. |
