getDate.d.ts 651 B

12345678910111213141516171819202122
  1. /**
  2. * @name getDate
  3. * @category Day Helpers
  4. * @summary Get the day of the month of the given date.
  5. *
  6. * @description
  7. * Get the day of the month of the given date.
  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 given date
  12. *
  13. * @returns The day of month
  14. *
  15. * @example
  16. * // Which day of the month is 29 February 2012?
  17. * const result = getDate(new Date(2012, 1, 29))
  18. * //=> 29
  19. */
  20. export declare function getDate<DateType extends Date>(
  21. date: DateType | number | string,
  22. ): number;