timepiece/node_modules/date-fns/getMonth.mjs

30 lines
742 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { toDate } from "./toDate.mjs";
/**
* @name getMonth
* @category Month Helpers
* @summary Get the month of the given date.
*
* @description
* Get the month of the given date.
*
* @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).
*
* @param date - The given date
*
* @returns The month index (0-11)
*
* @example
* // Which month is 29 February 2012?
* const result = getMonth(new Date(2012, 1, 29))
* //=> 1
*/
export function getMonth(date) {
const _date = toDate(date);
const month = _date.getMonth();
return month;
}
// Fallback for modularized imports:
export default getMonth;