getMonth.js 725 B

12345678910111213141516171819202122232425262728
  1. "use strict";
  2. exports.getMonth = getMonth;
  3. var _index = require("./toDate.js");
  4. /**
  5. * @name getMonth
  6. * @category Month Helpers
  7. * @summary Get the month of the given date.
  8. *
  9. * @description
  10. * Get the month of the given date.
  11. *
  12. * @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).
  13. *
  14. * @param date - The given date
  15. *
  16. * @returns The month index (0-11)
  17. *
  18. * @example
  19. * // Which month is 29 February 2012?
  20. * const result = getMonth(new Date(2012, 1, 29))
  21. * //=> 1
  22. */
  23. function getMonth(date) {
  24. const _date = (0, _index.toDate)(date);
  25. const month = _date.getMonth();
  26. return month;
  27. }