aboutsummaryrefslogtreecommitdiff
path: root/date-fns/src/differenceInCalendarMonths/index.ts
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-08-23 16:46:06 -0300
committerSebastian <sebasjm@gmail.com>2021-08-23 16:48:30 -0300
commit38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch)
tree453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/differenceInCalendarMonths/index.ts
parentf26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff)
downloadnode-vendor-master.tar.gz
node-vendor-master.tar.bz2
node-vendor-master.zip
added web vendorsHEADmaster
Diffstat (limited to 'date-fns/src/differenceInCalendarMonths/index.ts')
-rw-r--r--date-fns/src/differenceInCalendarMonths/index.ts42
1 files changed, 42 insertions, 0 deletions
diff --git a/date-fns/src/differenceInCalendarMonths/index.ts b/date-fns/src/differenceInCalendarMonths/index.ts
new file mode 100644
index 0000000..dcf1c44
--- /dev/null
+++ b/date-fns/src/differenceInCalendarMonths/index.ts
@@ -0,0 +1,42 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @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.
+ *
+ * ### v2.0.0 breaking changes:
+ *
+ * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
+ *
+ * @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?
+ * var result = differenceInCalendarMonths(
+ * new Date(2014, 8, 1),
+ * new Date(2014, 0, 31)
+ * )
+ * //=> 8
+ */
+export default function differenceInCalendarMonths(
+ dirtyDateLeft: Date | number,
+ dirtyDateRight: Date | number
+): number {
+ requiredArgs(2, arguments)
+
+ const dateLeft = toDate(dirtyDateLeft)
+ const dateRight = toDate(dirtyDateRight)
+
+ const yearDiff = dateLeft.getFullYear() - dateRight.getFullYear()
+ const monthDiff = dateLeft.getMonth() - dateRight.getMonth()
+
+ return yearDiff * 12 + monthDiff
+}