summaryrefslogtreecommitdiff
path: root/date-fns/src/yearsToQuarters/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/yearsToQuarters/index.ts')
-rw-r--r--date-fns/src/yearsToQuarters/index.ts25
1 files changed, 25 insertions, 0 deletions
diff --git a/date-fns/src/yearsToQuarters/index.ts b/date-fns/src/yearsToQuarters/index.ts
new file mode 100644
index 0000000..223e7d5
--- /dev/null
+++ b/date-fns/src/yearsToQuarters/index.ts
@@ -0,0 +1,25 @@
+import requiredArgs from '../_lib/requiredArgs/index'
+import { quartersInYear } from '../constants/index'
+
+/**
+ * @name yearsToQuarters
+ * @category Conversion Helpers
+ * @summary Convert years to quarters.
+ *
+ * @description
+ * Convert a number of years to a full number of quarters.
+ *
+ * @param {number} years - number of years to be converted
+ *
+ * @returns {number} the number of years converted in quarters
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // Convert 2 years to quarters
+ * const result = yearsToQuarters(2)
+ * //=> 8
+ */
+export default function yearsToQuarters(years: number): number {
+ requiredArgs(1, arguments)
+ return Math.floor(years * quartersInYear)
+}