12345678910111213141516171819202122232425262728 |
- import toDate from "../toDate/index.js";
- import startOfYear from "../startOfYear/index.js";
- import differenceInCalendarDays from "../differenceInCalendarDays/index.js";
- import requiredArgs from "../_lib/requiredArgs/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.
- *
- * @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?
- * const result = getDayOfYear(new Date(2014, 6, 2))
- * //=> 183
- */
- export default function getDayOfYear(dirtyDate) {
- requiredArgs(1, arguments);
- var date = toDate(dirtyDate);
- var diff = differenceInCalendarDays(date, startOfYear(date));
- var dayOfYear = diff + 1;
- return dayOfYear;
- }
|