getMonth.d.mts 628 B

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