32 lines
860 B
JavaScript
32 lines
860 B
JavaScript
|
import toDate from '../toDate/index.js';
|
||
|
|
/**
|
||
|
|
* @name getMonth
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Get the month of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the month of the given date.
|
||
|
|
*
|
||
|
|
* ### v2.0.0 breaking changes:
|
||
|
|
*
|
||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the given date
|
||
|
|
* @returns {Number} the month
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Which month is 29 February 2012?
|
||
|
|
* var result = getMonth(new Date(2012, 1, 29))
|
||
|
|
* //=> 1
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function getMonth(dirtyDate) {
|
||
|
|
if (arguments.length < 1) {
|
||
|
|
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
var month = date.getMonth();
|
||
|
|
return month;
|
||
|
|
}
|