#useCountdown

const ms = useCountdown(dateLike)
const countdown = useCountdown(dateLike, options) // with manual controls

type DateLike = string | number | Date | null | undefined

export type UseCountdownOptions<Controls extends boolean = false> = {
  /**
   * whether to start the countdown immediately
   *
   * @defaultValue true
   */
  immediate?: boolean
  /**
   * whether to expose the controls
   *
   * @defaultValue false
   */
  controls?: Controls
  /**
   * the interval to update the countdown
   *
   * @defaultValue 'requestAnimationFrame'
   */
  interval?: 'requestAnimationFrame' | number
  /**
   * a callback function to be called when the countdown is updated
   */
  onUpdate?: (ms: number, seconds: number) => void
  /**
   * a callback function to be called when the countdown is stopped
   */
  onStop?(): void
}

export type UseCountdownReturns<Controls extends boolean> = Controls extends true ? { ms: number } & Pausable : number