aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/differenceInCalendarDays/index.js
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2025-06-28 17:26:46 -0700
committerPinapelz <yukais@pinapelz.com>2025-06-28 17:43:56 -0700
commite4fa1e69e7ebfb627c7198fd1a9881e9327ec4d4 (patch)
tree06284a538a6008eca75051399e47db4e5d50301c /node_modules/date-fns/esm/differenceInCalendarDays/index.js
initial commit: scaffolding
Diffstat (limited to 'node_modules/date-fns/esm/differenceInCalendarDays/index.js')
-rw-r--r--node_modules/date-fns/esm/differenceInCalendarDays/index.js47
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/differenceInCalendarDays/index.js b/node_modules/date-fns/esm/differenceInCalendarDays/index.js
new file mode 100644
index 0000000..428933d
--- /dev/null
+++ b/node_modules/date-fns/esm/differenceInCalendarDays/index.js
@@ -0,0 +1,47 @@
+import getTimezoneOffsetInMilliseconds from "../_lib/getTimezoneOffsetInMilliseconds/index.js";
+import startOfDay from "../startOfDay/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+var MILLISECONDS_IN_DAY = 86400000;
+
+/**
+ * @name differenceInCalendarDays
+ * @category Day Helpers
+ * @summary Get the number of calendar days between the given dates.
+ *
+ * @description
+ * Get the number of calendar days between the given dates. This means that the times are removed
+ * from the dates and then the difference in days is calculated.
+ *
+ * @param {Date|Number} dateLeft - the later date
+ * @param {Date|Number} dateRight - the earlier date
+ * @returns {Number} the number of calendar days
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // How many calendar days are between
+ * // 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
+ * const result = differenceInCalendarDays(
+ * new Date(2012, 6, 2, 0, 0),
+ * new Date(2011, 6, 2, 23, 0)
+ * )
+ * //=> 366
+ * // How many calendar days are between
+ * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
+ * const result = differenceInCalendarDays(
+ * new Date(2011, 6, 3, 0, 1),
+ * new Date(2011, 6, 2, 23, 59)
+ * )
+ * //=> 1
+ */
+export default function differenceInCalendarDays(dirtyDateLeft, dirtyDateRight) {
+ requiredArgs(2, arguments);
+ var startOfDayLeft = startOfDay(dirtyDateLeft);
+ var startOfDayRight = startOfDay(dirtyDateRight);
+ var timestampLeft = startOfDayLeft.getTime() - getTimezoneOffsetInMilliseconds(startOfDayLeft);
+ var timestampRight = startOfDayRight.getTime() - getTimezoneOffsetInMilliseconds(startOfDayRight);
+
+ // Round the number of days to the nearest integer
+ // because the number of milliseconds in a day is not constant
+ // (e.g. it's different in the day of the daylight saving time clock shift)
+ return Math.round((timestampLeft - timestampRight) / MILLISECONDS_IN_DAY);
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage