aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/differenceInCalendarMonths/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/differenceInCalendarMonths/index.js')
-rw-r--r--node_modules/date-fns/esm/differenceInCalendarMonths/index.js31
1 files changed, 31 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/differenceInCalendarMonths/index.js b/node_modules/date-fns/esm/differenceInCalendarMonths/index.js
new file mode 100644
index 0000000..9bca8ed
--- /dev/null
+++ b/node_modules/date-fns/esm/differenceInCalendarMonths/index.js
@@ -0,0 +1,31 @@
+import toDate from "../toDate/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name differenceInCalendarMonths
+ * @category Month Helpers
+ * @summary Get the number of calendar months between the given dates.
+ *
+ * @description
+ * Get the number of calendar months between the given dates.
+ *
+ * @param {Date|Number} dateLeft - the later date
+ * @param {Date|Number} dateRight - the earlier date
+ * @returns {Number} the number of calendar months
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // How many calendar months are between 31 January 2014 and 1 September 2014?
+ * const result = differenceInCalendarMonths(
+ * new Date(2014, 8, 1),
+ * new Date(2014, 0, 31)
+ * )
+ * //=> 8
+ */
+export default function differenceInCalendarMonths(dirtyDateLeft, dirtyDateRight) {
+ requiredArgs(2, arguments);
+ var dateLeft = toDate(dirtyDateLeft);
+ var dateRight = toDate(dirtyDateRight);
+ var yearDiff = dateLeft.getFullYear() - dateRight.getFullYear();
+ var monthDiff = dateLeft.getMonth() - dateRight.getMonth();
+ return yearDiff * 12 + monthDiff;
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage