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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151 |
x4
x9
x9
x9
x9
x9
x9
x9
x9
x4
x4
x4
x4
x10
x10
x5
x5
x5
x5
x5
x5
x5
x5
x5
x10
x10
x10
x10
x10
x60
x60
x6
x6
x60
x6
x6
x60
x6
x6
x60
x6
x6
x60
x7
x7
x60
x6
x6
x60
x7
x7
x7
x60
x8
x8
x8
x60
x8
x8
x8
x60
x60
x10
x10 |
|
// Copyright 2018-2026 the Deno authors. MIT license.
// This module is browser compatible.
import { DAY, HOUR, MINUTE, SECOND, WEEK } from "./constants.ts";
/**
* Duration units for {@linkcode DifferenceFormat} and
* {@linkcode DifferenceOptions}.
*/
export type Unit =
| "milliseconds"
| "seconds"
| "minutes"
| "hours"
| "days"
| "weeks"
| "months"
| "quarters"
| "years";
/** Return type for {@linkcode difference}. */
export type DifferenceFormat = Partial<Record<Unit, number>>;
/** Options for {@linkcode difference}. */
export type DifferenceOptions = {
/**
* Units to calculate difference in. Defaults to all units.
*/
units?: Unit[];
};
function calculateMonthsDifference(from: Date, to: Date): number {
let months = (to.getFullYear() - from.getFullYear()) * 12 +
(to.getMonth() - from.getMonth());
if (to.getDate() < from.getDate()) {
months--;
}
return months;
}
/**
* Calculates the difference of the 2 given dates in various units. If the units
* are omitted, it returns the difference in the all available units.
*
* @param from Year to calculate difference from.
* @param to Year to calculate difference to.
* @param options Options such as units to calculate difference in.
* @returns The difference of the 2 given dates in various units.
*
* @example Basic usage
* ```ts
* import { difference } from "@std/datetime/difference";
* import { assertEquals } from "@std/assert";
*
* const date0 = new Date("2018-05-14");
* const date1 = new Date("2020-05-13");
*
* assertEquals(difference(date0, date1), {
* milliseconds: 63072000000,
* seconds: 63072000,
* minutes: 1051200,
* hours: 17520,
* days: 730,
* weeks: 104,
* months: 23,
* quarters: 7,
* years: 1
* });
* ```
*
* @example Calculate difference in specific units
*
* The `units` option defines which units to calculate the difference in.
*
* ```ts
* import { difference } from "@std/datetime/difference";
* import { assertEquals } from "@std/assert";
*
* const date0 = new Date("2018-05-14");
* const date1 = new Date("2020-05-13");
*
* const result = difference(date0, date1, { units: ["days", "months", "years"] });
*
* assertEquals(result, {
* days: 730,
* months: 23,
* years: 1
* });
* ```
*/
export function difference(
from: Date,
to: Date,
options?: DifferenceOptions,
): DifferenceFormat {
[from, to] = from < to ? [from, to] : [to, from];
const uniqueUnits = options?.units ? [...new Set(options?.units)] : [
"milliseconds",
"seconds",
"minutes",
"hours",
"days",
"weeks",
"months",
"quarters",
"years",
];
const differenceInMs = Math.abs(from.getTime() - to.getTime());
const differences: DifferenceFormat = {};
let months = null;
for (const uniqueUnit of uniqueUnits) {
switch (uniqueUnit) {
case "milliseconds":
differences.milliseconds = differenceInMs;
break;
case "seconds":
differences.seconds = Math.floor(differenceInMs / SECOND);
break;
case "minutes":
differences.minutes = Math.floor(differenceInMs / MINUTE);
break;
case "hours":
differences.hours = Math.floor(differenceInMs / HOUR);
break;
case "days":
differences.days = Math.floor(differenceInMs / DAY);
break;
case "weeks":
differences.weeks = Math.floor(differenceInMs / WEEK);
break;
case "months":
if (months === null) months = calculateMonthsDifference(from, to);
differences.months = months;
break;
case "quarters":
if (months === null) months = calculateMonthsDifference(from, to);
differences.quarters = Math.floor(months / 3);
break;
case "years":
if (months === null) months = calculateMonthsDifference(from, to);
differences.years = Math.floor(months / 12);
break;
}
}
return differences;
}
|