summaryrefslogtreecommitdiff
path: root/date-fns/src/lastDayOfYear/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/lastDayOfYear/index.ts')
-rw-r--r--date-fns/src/lastDayOfYear/index.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/lastDayOfYear/index.ts b/date-fns/src/lastDayOfYear/index.ts
new file mode 100644
index 0000000..f82c61c
--- /dev/null
+++ b/date-fns/src/lastDayOfYear/index.ts
@@ -0,0 +1,34 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name lastDayOfYear
+ * @category Year Helpers
+ * @summary Return the last day of a year for the given date.
+ *
+ * @description
+ * Return the last day of a year 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 last day of a year
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // The last day of a year for 2 September 2014 11:55:00:
+ * var result = lastDayOfYear(new Date(2014, 8, 2, 11, 55, 00))
+ * //=> Wed Dec 31 2014 00:00:00
+ */
+export default function lastDayOfYear(dirtyDate: Date | number): Date {
+ requiredArgs(1, arguments)
+
+ const date = toDate(dirtyDate)
+ const year = date.getFullYear()
+ date.setFullYear(year + 1, 0, 0)
+ date.setHours(0, 0, 0, 0)
+ return date
+}