forked from date-fns/date-fns
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
101 lines (85 loc) · 3.25 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
import { add } from "../add/index.js";
import { differenceInDays } from "../differenceInDays/index.js";
import { differenceInHours } from "../differenceInHours/index.js";
import { differenceInMinutes } from "../differenceInMinutes/index.js";
import { differenceInMonths } from "../differenceInMonths/index.js";
import { differenceInSeconds } from "../differenceInSeconds/index.js";
import { differenceInYears } from "../differenceInYears/index.js";
import { toDate } from "../toDate/index.js";
import type { Duration, Interval } from "../types.js";
type Options = { includeZeroValues?: boolean };
type RequiredDuration = Pick<
Required<Duration>,
"years" | "months" | "days" | "hours" | "minutes" | "seconds"
>;
type NormalizedDuration<O> = O extends { includeZeroValues: true }
? RequiredDuration
: Duration;
/**
* @name intervalToDuration
* @category Common Helpers
* @summary Convert interval to duration
*
* @description
* Convert a interval object to a duration object.
*
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
*
* @param interval - The interval to convert to duration
* @param options - The object with options
*
* @returns The duration object
*
* @example
* // Get the duration between January 15, 1929 and April 4, 1968.
* intervalToDuration({
* start: new Date(1929, 0, 15, 12, 0, 0),
* end: new Date(1968, 3, 4, 19, 5, 0)
* })
* // => { years: 39, months: 2, days: 20, hours: 7, minutes: 5 }
*
* @example
* // Get the duration with 0 values.
* intervalToDuration({
* start: new Date(1929, 0, 15, 12, 0, 0),
* end: new Date(1968, 3, 4, 19, 5, 0)
* }, { includeZeroValues: true })
* // => { years: 39, months: 2, days: 20, hours: 7, minutes: 5, seconds: 0 }
*/
export function intervalToDuration<DateType extends Date, O extends Options>(
interval: Interval<DateType>,
options?: O,
): NormalizedDuration<O> {
const start = toDate(interval.start);
const end = toDate(interval.end);
const duration = (
options?.includeZeroValues
? ({
years: 0,
months: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 0,
} satisfies RequiredDuration)
: {}
) as NormalizedDuration<O>;
const years = differenceInYears(end, start);
if (years) duration.years = years;
const remainingMonths = add(start, { years: duration.years });
const months = differenceInMonths(end, remainingMonths);
if (months) duration.months = months;
const remainingDays = add(remainingMonths, { months: duration.months });
const days = differenceInDays(end, remainingDays);
if (days) duration.days = days;
const remainingHours = add(remainingDays, { days: duration.days });
const hours = differenceInHours(end, remainingHours);
if (hours) duration.hours = hours;
const remainingMinutes = add(remainingHours, { hours: duration.hours });
const minutes = differenceInMinutes(end, remainingMinutes);
if (minutes) duration.minutes = minutes;
const remainingSeconds = add(remainingMinutes, { minutes: duration.minutes });
const seconds = differenceInSeconds(end, remainingSeconds);
if (seconds) duration.seconds = seconds;
return duration;
}