12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- "use strict";
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = eachYearOfInterval;
- var _index = _interopRequireDefault(require("../toDate/index.js"));
- var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
- /**
- * @name eachYearOfInterval
- * @category Interval Helpers
- * @summary Return the array of yearly timestamps within the specified time interval.
- *
- * @description
- * Return the array of yearly timestamps within the specified time interval.
- *
- * @param {Interval} interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns {Date[]} the array with starts of yearly timestamps from the month of the interval start to the month of the interval end
- * @throws {TypeError} 1 argument required
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each year between 6 February 2014 and 10 August 2017:
- * const result = eachYearOfInterval({
- * start: new Date(2014, 1, 6),
- * end: new Date(2017, 7, 10)
- * })
- * //=> [
- * // Wed Jan 01 2014 00:00:00,
- * // Thu Jan 01 2015 00:00:00,
- * // Fri Jan 01 2016 00:00:00,
- * // Sun Jan 01 2017 00:00:00
- * // ]
- */
- function eachYearOfInterval(dirtyInterval) {
- (0, _index2.default)(1, arguments);
- var interval = dirtyInterval || {};
- var startDate = (0, _index.default)(interval.start);
- var endDate = (0, _index.default)(interval.end);
- var endTime = endDate.getTime();
- // Throw an exception if start date is after end date or if any date is `Invalid Date`
- if (!(startDate.getTime() <= endTime)) {
- throw new RangeError('Invalid interval');
- }
- var dates = [];
- var currentDate = startDate;
- currentDate.setHours(0, 0, 0, 0);
- currentDate.setMonth(0, 1);
- while (currentDate.getTime() <= endTime) {
- dates.push((0, _index.default)(currentDate));
- currentDate.setFullYear(currentDate.getFullYear() + 1);
- }
- return dates;
- }
- module.exports = exports.default;
|