@checkdigit/time 1.0.0-PR.11-fede → 1.1.0

package/src/date-fns/differenceInWeeks/index.ts

@@ -1,56 +0,0 @@
-import differenceInDays from '../differenceInDays/index';
-import type { RoundingOptions } from '../types';
-import { getRoundingMethod } from '../_lib/roundingMethods/index';
-
-/**
- * The {@link differenceInWeeks} function options.
- */
-export interface DifferenceInWeeksOptions extends RoundingOptions {}
-
-/**
- * @name differenceInWeeks
- * @category Week Helpers
- * @summary Get the number of full weeks between the given dates.
- *
- * @description
- * Get the number of full weeks between two dates. Fractional weeks are
- * truncated towards zero by default.
- *
- * One "full week" is the distance between a local time in one day to the same
- * local time 7 days earlier or later. A full week can sometimes be less than
- * or more than 7*24 hours if a daylight savings change happens between two dates.
- *
- * To ignore DST and only measure exact 7*24-hour periods, use this instead:
- * `Math.floor(differenceInHours(dateLeft, dateRight)/(7*24))|0`.
- *
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @param options - an object with options.
- * @returns the number of full weeks
- *
- * @example
- * // How many full weeks are between 5 July 2014 and 20 July 2014?
- * const result = differenceInWeeks(new Date(2014, 6, 20), new Date(2014, 6, 5))
- * //=> 2
- *
- * // How many full weeks are between
- * // 1 March 2020 0:00 and 6 June 2020 0:00 ?
- * // Note: because local time is used, the
- * // result will always be 8 weeks (54 days),
- * // even if DST starts and the period has
- * // only 54*24-1 hours.
- * const result = differenceInWeeks(
- *   new Date(2020, 5, 1),
- *   new Date(2020, 2, 6)
- * )
- * //=> 8
- */
-export default function differenceInWeeks<DateType extends Date>(
-  dateLeft: DateType | number,
-  dateRight: DateType | number,
-  options?: DifferenceInWeeksOptions
-): number {
-  const diff = differenceInDays(dateLeft, dateRight) / 7;
-  return getRoundingMethod(options?.roundingMethod)(diff);
-}

package/src/date-fns/differenceInYears/index.ts

@@ -1,43 +0,0 @@
-import compareAsc from '../compareAsc/index';
-import differenceInCalendarYears from '../differenceInCalendarYears/index';
-import toDate from '../toDate/index';
-
-/**
- * @name differenceInYears
- * @category Year Helpers
- * @summary Get the number of full years between the given dates.
- *
- * @description
- * Get the number of full years between the given dates.
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of full years
- *
- * @example
- * // How many full years are between 31 December 2013 and 11 February 2015?
- * const result = differenceInYears(new Date(2015, 1, 11), new Date(2013, 11, 31))
- * //=> 1
- */
-export default function differenceInYears<DateType extends Date>(
-  dirtyDateLeft: DateType | number,
-  dirtyDateRight: DateType | number
-): number {
-  const dateLeft = toDate(dirtyDateLeft);
-  const dateRight = toDate(dirtyDateRight);
-
-  const sign = compareAsc(dateLeft, dateRight);
-  const difference = Math.abs(differenceInCalendarYears(dateLeft, dateRight));
-
-  // Set both dates to a valid leap year for accurate comparison when dealing
-  // with leap days
-  dateLeft.setFullYear(1584);
-  dateRight.setFullYear(1584);
-
-  // Math.abs(diff in full years - diff in calendar years) === 1 if last calendar year is not full
-  // If so, result must be decreased by 1 in absolute value
-  const isLastYearNotFull = compareAsc(dateLeft, dateRight) === -sign;
-  const result = sign * (difference - Number(isLastYearNotFull));
-  // Prevent negative zero
-  return result === 0 ? 0 : result;
-}

package/src/date-fns/eachDayOfInterval/index.ts

@@ -1,67 +0,0 @@
-import toDate from '../toDate/index';
-import type { Interval, StepOptions } from '../types';
-
-/**
- * The {@link eachDayOfInterval} function options.
- */
-export interface EachDayOfIntervalOptions extends StepOptions {}
-
-/**
- * @name eachDayOfInterval
- * @category Interval Helpers
- * @summary Return the array of dates within the specified time interval.
- *
- * @description
- * Return the array of dates within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of days from the day of the interval start to the day of the interval end
- * @throws {RangeError} `options.step` must be a number greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each day between 6 October 2014 and 10 October 2014:
- * const result = eachDayOfInterval({
- *   start: new Date(2014, 9, 6),
- *   end: new Date(2014, 9, 10)
- * })
- * //=> [
- * //   Mon Oct 06 2014 00:00:00,
- * //   Tue Oct 07 2014 00:00:00,
- * //   Wed Oct 08 2014 00:00:00,
- * //   Thu Oct 09 2014 00:00:00,
- * //   Fri Oct 10 2014 00:00:00
- * // ]
- */
-export default function eachDayOfInterval<DateType extends Date>(
-  interval: Interval<DateType>,
-  options?: EachDayOfIntervalOptions
-): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  const 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');
-  }
-
-  const dates = [];
-
-  const currentDate = startDate;
-  currentDate.setHours(0, 0, 0, 0);
-
-  const step = options?.step ?? 1;
-  if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number greater than 1');
-
-  while (currentDate.getTime() <= endTime) {
-    dates.push(toDate(currentDate));
-    currentDate.setDate(currentDate.getDate() + step);
-    currentDate.setHours(0, 0, 0, 0);
-  }
-
-  return dates;
-}

package/src/date-fns/eachHourOfInterval/index.ts

@@ -1,67 +0,0 @@
-import addHours from '../addHours/index';
-import toDate from '../toDate/index';
-import type { Interval, StepOptions } from '../types';
-
-/**
- * The {@link eachHourOfInterval} function options.
- */
-export interface EachHourOfIntervalOptions extends StepOptions {}
-
-/**
- * @name eachHourOfInterval
- * @category Interval Helpers
- * @summary Return the array of hours within the specified time interval.
- *
- * @description
- * Return the array of hours within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of hours from the hour of the interval start to the hour of the interval end
- * @throws {RangeError} `options.step` must be a number greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
- * const result = eachHourOfInterval({
- *   start: new Date(2014, 9, 6, 12),
- *   end: new Date(2014, 9, 6, 15)
- * })
- * //=> [
- * //   Mon Oct 06 2014 12:00:00,
- * //   Mon Oct 06 2014 13:00:00,
- * //   Mon Oct 06 2014 14:00:00,
- * //   Mon Oct 06 2014 15:00:00
- * // ]
- */
-export default function eachHourOfInterval<DateType extends Date>(
-  interval: Interval<DateType>,
-  options?: EachHourOfIntervalOptions
-): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  const startTime = startDate.getTime();
-  const endTime = endDate.getTime();
-
-  // Throw an exception if start date is after end date or if any date is `Invalid Date`
-  if (!(startTime <= endTime)) {
-    throw new RangeError('Invalid interval');
-  }
-
-  const dates = [];
-
-  let currentDate = startDate;
-  currentDate.setMinutes(0, 0, 0);
-
-  const step = options?.step ?? 1;
-  if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number greater than 1');
-
-  while (currentDate.getTime() <= endTime) {
-    dates.push(toDate(currentDate));
-    currentDate = addHours(currentDate, step);
-  }
-
-  return dates;
-}

package/src/date-fns/eachMinuteOfInterval/index.ts

@@ -1,66 +0,0 @@
-import addMinutes from '../addMinutes/index';
-import startOfMinute from '../startOfMinute/index';
-import toDate from '../toDate/index';
-import type { Interval, StepOptions } from '../types';
-
-/**
- * The {@link eachMinuteOfInterval} function options.
- */
-export interface EachMinuteOfIntervalOptions extends StepOptions {}
-
-/**
- * @name eachMinuteOfInterval
- * @category Interval Helpers
- * @summary Return the array of minutes within the specified time interval.
- *
- * @description
- * Returns the array of minutes within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of minutes from the minute of the interval start to the minute of the interval end
- * @throws {RangeError} `options.step` must be a number equal to or greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each minute between 14 October 2020, 13:00 and 14 October 2020, 13:03
- * const result = eachMinuteOfInterval({
- *   start: new Date(2014, 9, 14, 13),
- *   end: new Date(2014, 9, 14, 13, 3)
- * })
- * //=> [
- * //   Wed Oct 14 2014 13:00:00,
- * //   Wed Oct 14 2014 13:01:00,
- * //   Wed Oct 14 2014 13:02:00,
- * //   Wed Oct 14 2014 13:03:00
- * // ]
- */
-export default function eachMinuteOfInterval<DateType extends Date>(
-  interval: Interval<DateType>,
-  options?: EachMinuteOfIntervalOptions
-): DateType[] {
-  const startDate = startOfMinute(toDate(interval.start));
-  const endDate = toDate(interval.end);
-
-  const startTime = startDate.getTime();
-  const endTime = endDate.getTime();
-
-  if (startTime >= endTime) {
-    throw new RangeError('Invalid interval');
-  }
-
-  const dates = [];
-
-  let currentDate = startDate;
-
-  const step = options?.step ?? 1;
-  if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number equal to or greater than 1');
-
-  while (currentDate.getTime() <= endTime) {
-    dates.push(toDate(currentDate));
-    currentDate = addMinutes(currentDate, step);
-  }
-
-  return dates;
-}

package/src/date-fns/eachMonthOfInterval/index.ts

@@ -1,55 +0,0 @@
-import toDate from '../toDate/index';
-import type { Interval } from '../types';
-
-/**
- * @name eachMonthOfInterval
- * @category Interval Helpers
- * @summary Return the array of months within the specified time interval.
- *
- * @description
- * Return the array of months within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of months from the month of the interval start to the month of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each month between 6 February 2014 and 10 August 2014:
- * const result = eachMonthOfInterval({
- *   start: new Date(2014, 1, 6),
- *   end: new Date(2014, 7, 10)
- * })
- * //=> [
- * //   Sat Feb 01 2014 00:00:00,
- * //   Sat Mar 01 2014 00:00:00,
- * //   Tue Apr 01 2014 00:00:00,
- * //   Thu May 01 2014 00:00:00,
- * //   Sun Jun 01 2014 00:00:00,
- * //   Tue Jul 01 2014 00:00:00,
- * //   Fri Aug 01 2014 00:00:00
- * // ]
- */
-export default function eachMonthOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  const endTime = endDate.getTime();
-  const dates = [];
-
-  // 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');
-  }
-
-  const currentDate = startDate;
-  currentDate.setHours(0, 0, 0, 0);
-  currentDate.setDate(1);
-
-  while (currentDate.getTime() <= endTime) {
-    dates.push(toDate(currentDate));
-    currentDate.setMonth(currentDate.getMonth() + 1);
-  }
-
-  return dates;
-}

package/src/date-fns/eachQuarterOfInterval/index.ts

@@ -1,57 +0,0 @@
-import addQuarters from '../addQuarters/index';
-import startOfQuarter from '../startOfQuarter/index';
-import toDate from '../toDate/index';
-import type { Interval } from '../types';
-
-/**
- * @name eachQuarterOfInterval
- * @category Interval Helpers
- * @summary Return the array of quarters within the specified time interval.
- *
- * @description
- * Return the array of quarters within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of quarters from the quarter of the interval start to the quarter of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each quarter within interval 6 February 2014 - 10 August 2014:
- * const result = eachQuarterOfInterval({
- *   start: new Date(2014, 1, 6),
- *   end: new Date(2014, 7, 10)
- * })
- * //=> [
- * //   Wed Jan 01 2014 00:00:00,
- * //   Tue Apr 01 2014 00:00:00,
- * //   Tue Jul 01 2014 00:00:00,
- * // ]
- */
-export default function eachQuarterOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  let 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');
-  }
-
-  const startDateQuarter = startOfQuarter(startDate);
-  const endDateQuarter = startOfQuarter(endDate);
-
-  endTime = endDateQuarter.getTime();
-
-  const quarters = [];
-
-  let currentQuarter = startDateQuarter;
-
-  while (currentQuarter.getTime() <= endTime) {
-    quarters.push(toDate(currentQuarter));
-    currentQuarter = addQuarters(currentQuarter, 1);
-  }
-
-  return quarters;
-}

package/src/date-fns/eachWeekOfInterval/index.ts

@@ -1,77 +0,0 @@
-import addWeeks from '../addWeeks/index';
-import startOfWeek from '../startOfWeek/index';
-import toDate from '../toDate/index';
-import type { Interval, LocaleOptions, WeekStartOptions } from '../types';
-
-/**
- * The {@link eachWeekOfInterval} function options.
- */
-export interface EachWeekOfIntervalOptions extends WeekStartOptions, LocaleOptions {}
-
-/**
- * @name eachWeekOfInterval
- * @category Interval Helpers
- * @summary Return the array of weeks within the specified time interval.
- *
- * @description
- * Return the array of weeks within the specified time interval.
- *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of weeks from the week of the interval start to the week of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each week within interval 6 October 2014 - 23 November 2014:
- * const result = eachWeekOfInterval({
- *   start: new Date(2014, 9, 6),
- *   end: new Date(2014, 10, 23)
- * })
- * //=> [
- * //   Sun Oct 05 2014 00:00:00,
- * //   Sun Oct 12 2014 00:00:00,
- * //   Sun Oct 19 2014 00:00:00,
- * //   Sun Oct 26 2014 00:00:00,
- * //   Sun Nov 02 2014 00:00:00,
- * //   Sun Nov 09 2014 00:00:00,
- * //   Sun Nov 16 2014 00:00:00,
- * //   Sun Nov 23 2014 00:00:00
- * // ]
- */
-export default function eachWeekOfInterval<DateType extends Date>(
-  interval: Interval<DateType>,
-  options?: EachWeekOfIntervalOptions
-): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  let 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');
-  }
-
-  const startDateWeek = startOfWeek(startDate, options);
-  const endDateWeek = startOfWeek(endDate, options);
-
-  // Some timezones switch DST at midnight, making start of day unreliable in these timezones, 3pm is a safe bet
-  startDateWeek.setHours(15);
-  endDateWeek.setHours(15);
-
-  endTime = endDateWeek.getTime();
-
-  const weeks = [];
-
-  let currentWeek = startDateWeek;
-
-  while (currentWeek.getTime() <= endTime) {
-    currentWeek.setHours(0);
-    weeks.push(toDate(currentWeek));
-    currentWeek = addWeeks(currentWeek, 1);
-    currentWeek.setHours(15);
-  }
-
-  return weeks;
-}

package/src/date-fns/eachWeekendOfInterval/index.ts

@@ -1,44 +0,0 @@
-import eachDayOfInterval from '../eachDayOfInterval/index';
-import isSunday from '../isSunday/index';
-import isWeekend from '../isWeekend/index';
-import type { Interval } from '../types';
-
-/**
- * @name eachWeekendOfInterval
- * @category Interval Helpers
- * @summary List all the Saturdays and Sundays in the given date interval.
- *
- * @description
- * Get all the Saturdays and Sundays in the given date interval.
- *
- * @param interval - the given interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Lists all Saturdays and Sundays in the given date interval
- * const result = eachWeekendOfInterval({
- *   start: new Date(2018, 8, 17),
- *   end: new Date(2018, 8, 30)
- * })
- * //=> [
- * //   Sat Sep 22 2018 00:00:00,
- * //   Sun Sep 23 2018 00:00:00,
- * //   Sat Sep 29 2018 00:00:00,
- * //   Sun Sep 30 2018 00:00:00
- * // ]
- */
-export default function eachWeekendOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[] {
-  const dateInterval = eachDayOfInterval(interval);
-  const weekends = [];
-  let index = 0;
-  while (index < dateInterval.length) {
-    const date = dateInterval[index++] as DateType;
-    if (isWeekend(date)) {
-      weekends.push(date);
-      if (isSunday(date)) index = index + 5;
-    }
-  }
-  return weekends;
-}

package/src/date-fns/eachWeekendOfMonth/index.ts

@@ -1,37 +0,0 @@
-import eachWeekendOfInterval from '../eachWeekendOfInterval/index';
-import endOfMonth from '../endOfMonth/index';
-import startOfMonth from '../startOfMonth/index';
-
-/**
- * @name eachWeekendOfMonth
- * @category Month Helpers
- * @summary List all the Saturdays and Sundays in the given month.
- *
- * @description
- * Get all the Saturdays and Sundays in the given month.
- *
- * @param date - the given month
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The passed date is invalid
- *
- * @example
- * // Lists all Saturdays and Sundays in the given month
- * const result = eachWeekendOfMonth(new Date(2022, 1, 1))
- * //=> [
- * //   Sat Feb 05 2022 00:00:00,
- * //   Sun Feb 06 2022 00:00:00,
- * //   Sat Feb 12 2022 00:00:00,
- * //   Sun Feb 13 2022 00:00:00,
- * //   Sat Feb 19 2022 00:00:00,
- * //   Sun Feb 20 2022 00:00:00,
- * //   Sat Feb 26 2022 00:00:00,
- * //   Sun Feb 27 2022 00:00:00
- * // ]
- */
-export default function eachWeekendOfMonth<DateType extends Date>(dirtyDate: DateType): DateType[] {
-  const startDate = startOfMonth(dirtyDate);
-  if (isNaN(startDate.getTime())) throw new RangeError('The passed date is invalid');
-
-  const endDate = endOfMonth(dirtyDate);
-  return eachWeekendOfInterval({ start: startDate, end: endDate });
-}

package/src/date-fns/eachWeekendOfYear/index.ts

@@ -1,32 +0,0 @@
-import eachWeekendOfInterval from '../eachWeekendOfInterval/index';
-import endOfYear from '../endOfYear/index';
-import startOfYear from '../startOfYear/index';
-
-/**
- * @name eachWeekendOfYear
- * @category Year Helpers
- * @summary List all the Saturdays and Sundays in the year.
- *
- * @description
- * Get all the Saturdays and Sundays in the year.
- *
- * @param date - the given year
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The passed date is invalid
- *
- * @example
- * // Lists all Saturdays and Sundays in the year
- * const result = eachWeekendOfYear(new Date(2020, 1, 1))
- * //=> [
- * //   Sat Jan 03 2020 00:00:00,
- * //   Sun Jan 04 2020 00:00:00,
- * //   ...
- * //   Sun Dec 27 2020 00:00:00
- * // ]
- * ]
- */
-export default function eachWeekendOfYear<DateType extends Date>(dirtyDate: DateType | number): DateType[] {
-  const startDate = startOfYear(dirtyDate);
-  const endDate = endOfYear(dirtyDate);
-  return eachWeekendOfInterval({ start: startDate, end: endDate });
-}

package/src/date-fns/eachYearOfInterval/index.ts

@@ -1,53 +0,0 @@
-import toDate from '../toDate/index';
-import type { Interval } from '../types';
-
-/**
- * @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 - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of yearly timestamps from the month of the interval start to the month of the interval end
- * @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
- * // ]
- */
-export default function eachYearOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[] {
-  const startDate = toDate(interval.start);
-  const endDate = toDate(interval.end);
-
-  const 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');
-  }
-
-  const dates = [];
-
-  const currentDate = startDate;
-  currentDate.setHours(0, 0, 0, 0);
-  currentDate.setMonth(0, 1);
-
-  while (currentDate.getTime() <= endTime) {
-    dates.push(toDate(currentDate));
-    currentDate.setFullYear(currentDate.getFullYear() + 1);
-  }
-
-  return dates;
-}

package/src/date-fns/endOfDay/index.ts

@@ -1,24 +0,0 @@
-import toDate from '../toDate/index';
-
-/**
- * @name endOfDay
- * @category Day Helpers
- * @summary Return the end of a day for the given date.
- *
- * @description
- * Return the end of a day for the given date.
- * The result will be in the local timezone.
- *
- * @param date - the original date
- * @returns the end of a day
- *
- * @example
- * // The end of a day for 2 September 2014 11:55:00:
- * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Tue Sep 02 2014 23:59:59.999
- */
-export default function endOfDay<DateType extends Date>(dirtyDate: DateType | number): DateType {
-  const date = toDate(dirtyDate);
-  date.setHours(23, 59, 59, 999);
-  return date;
-}