32 lines
850 B
JavaScript
32 lines
850 B
JavaScript
|
import toDate from '../toDate/index.js';
|
||
|
/**
|
||
|
* @name getYear
|
||
|
* @category Year Helpers
|
||
|
* @summary Get the year of the given date.
|
||
|
*
|
||
|
* @description
|
||
|
* Get the year 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 year
|
||
|
* @throws {TypeError} 1 argument required
|
||
|
*
|
||
|
* @example
|
||
|
* // Which year is 2 July 2014?
|
||
|
* var result = getYear(new Date(2014, 6, 2))
|
||
|
* //=> 2014
|
||
|
*/
|
||
|
|
||
|
export default function getYear(dirtyDate) {
|
||
|
if (arguments.length < 1) {
|
||
|
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||
|
}
|
||
|
|
||
|
var date = toDate(dirtyDate);
|
||
|
var year = date.getFullYear();
|
||
|
return year;
|
||
|
}
|