index.js 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. import toDate from "../toDate/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name endOfDecade
  5. * @category Decade Helpers
  6. * @summary Return the end of a decade for the given date.
  7. *
  8. * @description
  9. * Return the end of a decade for the given date.
  10. *
  11. * @param {Date|Number} date - the original date
  12. * @returns {Date} the end of a decade
  13. * @param {Object} [options] - an object with options.
  14. * @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link https://date-fns.org/docs/toDate}
  15. * @throws {TypeError} 1 argument required
  16. * @throws {RangeError} `options.additionalDigits` must be 0, 1 or 2
  17. *
  18. * @example
  19. * // The end of a decade for 12 May 1984 00:00:00:
  20. * const result = endOfDecade(new Date(1984, 4, 12, 00, 00, 00))
  21. * //=> Dec 31 1989 23:59:59.999
  22. */
  23. export default function endOfDecade(dirtyDate) {
  24. requiredArgs(1, arguments);
  25. var date = toDate(dirtyDate);
  26. var year = date.getFullYear();
  27. var decade = 9 + Math.floor(year / 10) * 10;
  28. date.setFullYear(decade, 11, 31);
  29. date.setHours(23, 59, 59, 999);
  30. return date;
  31. }