summaryrefslogtreecommitdiff
path: root/date-fns/src/endOfMonth/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/endOfMonth/index.ts')
-rw-r--r--date-fns/src/endOfMonth/index.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/endOfMonth/index.ts b/date-fns/src/endOfMonth/index.ts
new file mode 100644
index 0000000..e5b8f9c
--- /dev/null
+++ b/date-fns/src/endOfMonth/index.ts
@@ -0,0 +1,34 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name endOfMonth
+ * @category Month Helpers
+ * @summary Return the end of a month for the given date.
+ *
+ * @description
+ * Return the end of a month for the given date.
+ * The result will be in the local timezone.
+ *
+ * ### 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} date - the original date
+ * @returns {Date} the end of a month
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // The end of a month for 2 September 2014 11:55:00:
+ * const result = endOfMonth(new Date(2014, 8, 2, 11, 55, 0))
+ * //=> Tue Sep 30 2014 23:59:59.999
+ */
+export default function endOfMonth(dirtyDate: Date | number): Date {
+ requiredArgs(1, arguments)
+
+ const date = toDate(dirtyDate)
+ const month = date.getMonth()
+ date.setFullYear(date.getFullYear(), month + 1, 0)
+ date.setHours(23, 59, 59, 999)
+ return date
+}