isLastDayOfMonth.d.ts 702 B

12345678910111213141516171819202122
  1. /**
  2. * @name isLastDayOfMonth
  3. * @category Month Helpers
  4. * @summary Is the given date the last day of a month?
  5. *
  6. * @description
  7. * Is the given date the last day of a month?
  8. *
  9. * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
  10. *
  11. * @param date - The date to check
  12. * @returns The date is the last day of a month
  13. *
  14. * @example
  15. * // Is 28 February 2014 the last day of a month?
  16. * const result = isLastDayOfMonth(new Date(2014, 1, 28))
  17. * //=> true
  18. */
  19. export declare function isLastDayOfMonth<DateType extends Date>(
  20. date: DateType | number | string,
  21. ): boolean;