Add yearsToDays Function

MAKWritingHouse · MAKWritingHouse · commit 77eaa3bfe914 · 2023-10-25T22:42:39.000+05:00
diff --git a/package.json b/package.json
@@ -993,6 +993,10 @@
       "require": "./yearsToMonths.js",
       "import": "./yearsToMonths.mjs"
     },
+    "./yearsToDays": {
+      "require": "./yearsToDays.js",
+      "import": "./yearsToDays.mjs"
+    },
     "./yearsToQuarters": {
       "require": "./yearsToQuarters.js",
       "import": "./yearsToQuarters.mjs"
@@ -2009,6 +2013,10 @@
       "require": "./fp/yearsToMonths.js",
       "import": "./fp/yearsToMonths.mjs"
     },
+    "./fp/yearsToDays": {
+      "require": "./fp/yearsToDays.js",
+      "import": "./fp/yearsToDays.mjs"
+    },
     "./fp/yearsToQuarters": {
       "require": "./fp/yearsToQuarters.js",
       "import": "./fp/yearsToQuarters.mjs"
diff --git a/src/index.ts b/src/index.ts
@@ -240,5 +240,6 @@ export { default as toDate } from './toDate/index'
 export { default as transpose } from './transpose/index'
 export { default as weeksToDays } from './weeksToDays/index'
 export { default as yearsToMonths } from './yearsToMonths/index'
+export { default as yearsToDays } from './yearsToDays/index'
 export { default as yearsToQuarters } from './yearsToQuarters/index'
 export * from './constants/index'
diff --git a/src/yearsToDays/index.ts b/src/yearsToDays/index.ts
@@ -0,0 +1,22 @@
+import { daysInYear } from '../constants/index'
+
+/**
+ * @name yearsToDays
+ * @category Conversion Helpers
+ * @summary Convert years to days.
+ *
+ * @description
+ * Convert a number of years to a full number of days.
+ *
+ * @param years - The number of years to be converted
+ *
+ * @returns The number of years converted in days
+ *
+ * @example
+ * // Convert 2 years into days
+ * const result = yearsToDays(2)
+ * //=> 24
+ */
+export default function yearsToDays(years: number): number {
+  return Math.floor(years * daysInYear)
+}
diff --git a/src/yearsToDays/test.ts b/src/yearsToDays/test.ts
@@ -0,0 +1,22 @@
+/* eslint-env mocha */
+
+import assert from 'assert'
+import { describe, it } from 'vitest'
+import yearsToDays from './index'
+
+describe('yearsToDays', () => {
+  it('converts years to days', () => {
+    assert(yearsToDays(1) === 365)
+    assert(yearsToDays(2) === 730)
+  })
+
+  it('uses floor rounding', () => {
+    assert(yearsToDays(1.7) === 620)
+    assert(yearsToDays(0.1) === 36)
+  })
+
+  it('handles border values', () => {
+    assert(yearsToDays(1.5) === 547)
+    assert(yearsToDays(0) === 0)
+  })
+})
diff --git a/typedoc.json b/typedoc.json
@@ -242,6 +242,7 @@
     "./src/transpose/index.ts",
     "./src/weeksToDays/index.ts",
     "./src/yearsToMonths/index.ts",
+    "./src/yearsToDays/index.ts",
     "./src/yearsToQuarters/index.ts",
     "./src/constants/index.ts"
   ],
