index.js 880 B

12345678910111213141516171819202122232425262728
  1. import toDate from "../toDate/index.js";
  2. import startOfYear from "../startOfYear/index.js";
  3. import differenceInCalendarDays from "../differenceInCalendarDays/index.js";
  4. import requiredArgs from "../_lib/requiredArgs/index.js";
  5. /**
  6. * @name getDayOfYear
  7. * @category Day Helpers
  8. * @summary Get the day of the year of the given date.
  9. *
  10. * @description
  11. * Get the day of the year of the given date.
  12. *
  13. * @param {Date|Number} date - the given date
  14. * @returns {Number} the day of year
  15. * @throws {TypeError} 1 argument required
  16. *
  17. * @example
  18. * // Which day of the year is 2 July 2014?
  19. * const result = getDayOfYear(new Date(2014, 6, 2))
  20. * //=> 183
  21. */
  22. export default function getDayOfYear(dirtyDate) {
  23. requiredArgs(1, arguments);
  24. var date = toDate(dirtyDate);
  25. var diff = differenceInCalendarDays(date, startOfYear(date));
  26. var dayOfYear = diff + 1;
  27. return dayOfYear;
  28. }