index.js 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = eachWeekendOfYear;
  7. var _index = _interopRequireDefault(require("../eachWeekendOfInterval/index.js"));
  8. var _index2 = _interopRequireDefault(require("../endOfYear/index.js"));
  9. var _index3 = _interopRequireDefault(require("../startOfYear/index.js"));
  10. var _index4 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  11. /**
  12. * @name eachWeekendOfYear
  13. * @category Year Helpers
  14. * @summary List all the Saturdays and Sundays in the year.
  15. *
  16. * @description
  17. * Get all the Saturdays and Sundays in the year.
  18. *
  19. * @param {Date|Number} date - the given year
  20. * @returns {Date[]} an array containing all the Saturdays and Sundays
  21. * @throws {TypeError} 1 argument required
  22. * @throws {RangeError} The passed date is invalid
  23. *
  24. * @example
  25. * // Lists all Saturdays and Sundays in the year
  26. * const result = eachWeekendOfYear(new Date(2020, 1, 1))
  27. * //=> [
  28. * // Sat Jan 03 2020 00:00:00,
  29. * // Sun Jan 04 2020 00:00:00,
  30. * // ...
  31. * // Sun Dec 27 2020 00:00:00
  32. * // ]
  33. * ]
  34. */
  35. function eachWeekendOfYear(dirtyDate) {
  36. (0, _index4.default)(1, arguments);
  37. var startDate = (0, _index3.default)(dirtyDate);
  38. var endDate = (0, _index2.default)(dirtyDate);
  39. return (0, _index.default)({
  40. start: startDate,
  41. end: endDate
  42. });
  43. }
  44. module.exports = exports.default;