summaryrefslogtreecommitdiff
path: root/date-fns/src/startOfYear/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/startOfYear/index.ts
parentf26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff)
downloadnode-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz
node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2
node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip
added web vendorsHEADmaster
Diffstat (limited to 'date-fns/src/startOfYear/index.ts')
-rw-r--r--date-fns/src/startOfYear/index.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/startOfYear/index.ts b/date-fns/src/startOfYear/index.ts
new file mode 100644
index 0000000..b72be94
--- /dev/null
+++ b/date-fns/src/startOfYear/index.ts
@@ -0,0 +1,34 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name startOfYear
+ * @category Year Helpers
+ * @summary Return the start of a year for the given date.
+ *
+ * @description
+ * Return the start 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 start of a year
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // The start of a year for 2 September 2014 11:55:00:
+ * const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
+ * //=> Wed Jan 01 2014 00:00:00
+ */
+export default function startOfYear(dirtyDate: Date | number): Date {
+ requiredArgs(1, arguments)
+
+ const cleanDate = toDate(dirtyDate)
+ const date = new Date(0)
+ date.setFullYear(cleanDate.getFullYear(), 0, 1)
+ date.setHours(0, 0, 0, 0)
+ return date
+}