Update jsDoc for useCountdown

juliencrn · Nov 25, 2024 · 405f0a8 · 405f0a8
1 parent 2066727
commit 405f0a8
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/packages/usehooks-ts/src/useCountdown/useCountdown.ts b/packages/usehooks-ts/src/useCountdown/useCountdown.ts
@@ -45,11 +45,12 @@ type CountdownControllers = {
  * @see [Documentation](https://usehooks-ts.com/react-hook/use-countdown)
  * @example
  * ```tsx
- * const [counter, { start, stop, reset }] = useCountdown({
- *   countStart: 10,
- *   intervalMs: 1000,
- *   isIncrement: false,
- * });
+ *  const [counter, { startCountdown, stopCountdown, resetCountdown }] =
+ *    useCountdown({useCountdown({
+ *     countStart: 10,
+ *     intervalMs: 1000,
+ *     isIncrement: false,
+ *   });
  * ```
  */
 export function useCountdown({