24 lines
598 B
JavaScript
24 lines
598 B
JavaScript
|
import toDate from "../toDate/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @name getYear
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Get the year of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the year of the given date.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the given date
|
||
|
|
* @returns {Number} the year
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Which year is 2 July 2014?
|
||
|
|
* const result = getYear(new Date(2014, 6, 2))
|
||
|
|
* //=> 2014
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function getYear(dirtyDate) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
return toDate(dirtyDate).getFullYear();
|
||
|
|
}
|