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