summaryrefslogtreecommitdiff
path: root/date-fns/src/differenceInMinutes/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/differenceInMinutes/index.js')
-rw-r--r--date-fns/src/differenceInMinutes/index.js46
1 files changed, 46 insertions, 0 deletions
diff --git a/date-fns/src/differenceInMinutes/index.js b/date-fns/src/differenceInMinutes/index.js
new file mode 100644
index 0000000..c1b103c
--- /dev/null
+++ b/date-fns/src/differenceInMinutes/index.js
@@ -0,0 +1,46 @@
+import differenceInMilliseconds from '../differenceInMilliseconds/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+var MILLISECONDS_IN_MINUTE = 60000
+
+/**
+ * @name differenceInMinutes
+ * @category Minute Helpers
+ * @summary Get the number of minutes between the given dates.
+ *
+ * @description
+ * Get the signed number of full (rounded towards 0) minutes 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 minutes
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
+ * var result = differenceInMinutes(
+ * new Date(2014, 6, 2, 12, 20, 0),
+ * new Date(2014, 6, 2, 12, 7, 59)
+ * )
+ * //=> 12
+ *
+ * @example
+ * // How many minutes are from 10:01:59 to 10:00:00
+ * var result = differenceInMinutes(
+ * new Date(2000, 0, 1, 10, 0, 0),
+ * new Date(2000, 0, 1, 10, 1, 59)
+ * )
+ * //=> -1
+ */
+export default function differenceInMinutes(dirtyDateLeft, dirtyDateRight) {
+ requiredArgs(2, arguments)
+
+ var diff =
+ differenceInMilliseconds(dirtyDateLeft, dirtyDateRight) /
+ MILLISECONDS_IN_MINUTE
+ return diff > 0 ? Math.floor(diff) : Math.ceil(diff)
+}