isThisMinute.d.ts 609 B

123456789101112131415161718192021
  1. import type { DateArg } from "./types.js";
  2. /**
  3. * @name isThisMinute
  4. * @category Minute Helpers
  5. * @summary Is the given date in the same minute as the current date?
  6. * @pure false
  7. *
  8. * @description
  9. * Is the given date in the same minute as the current date?
  10. *
  11. * @param date - The date to check
  12. *
  13. * @returns The date is in this minute
  14. *
  15. * @example
  16. * // If now is 25 September 2014 18:30:15.500,
  17. * // is 25 September 2014 18:30:00 in this minute?
  18. * const result = isThisMinute(new Date(2014, 8, 25, 18, 30))
  19. * //=> true
  20. */
  21. export declare function isThisMinute(date: DateArg<Date> & {}): boolean;