feat: adds randomFloatBetween

MakerXStudio · Jun 29, 2022 · ab87f44 · ab87f44
1 parent 288f853
commit ab87f44
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/src/data-utilties.ts b/src/data-utilties.ts
@@ -27,6 +27,11 @@ export function randomNumberBetween(min: number, max: number): number {
   return Math.floor(Math.random() * (max - min + 1) + min)
 }
 
+export function randomFloatBetween(min: number, max: number, decimals?: number) {
+  const float = Math.random() * (max - min) + min
+  return decimals ? parseFloat(float.toFixed(decimals)) : float
+}
+
 /**
  * Generates a random string with a length between `min` and `max`
  *

diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,7 @@ export {
   randomDate,
   randomDateBetween,
   randomNumberBetween,
+  randomFloatBetween,
   randomNumber,
   incrementedNumber,
   randomId,

diff --git a/test/data-utilities.spec.ts b/test/data-utilities.spec.ts
@@ -7,6 +7,7 @@ import {
   randomDateRangeMin,
   randomElement,
   randomEmail,
+  randomFloatBetween,
   randomId,
   randomNumber,
   randomNumberBetween,
@@ -32,6 +33,20 @@ describe('Data utilities', () => {
       expect(sut).toBeLessThanOrEqual(10)
     })
   })
+  describe('randomFloatBetween', () => {
+    it('generates a random float between two inputs', () => {
+      for (let i = 1; i < 99; i++) {
+        const decimalPlaces = randomNumberBetween(1, 20)
+
+        const sut = randomFloatBetween(0, i, decimalPlaces)
+        const decimals = sut.toLocaleString('en-au').split('.')
+
+        if (decimals.length === 2) expect(sut.toLocaleString('en-au').split('.')[1].length).toBeLessThanOrEqual(decimalPlaces)
+        expect(sut).toBeGreaterThanOrEqual(0)
+        expect(sut).toBeLessThanOrEqual(i)
+      }
+    })
+  })
   describe('randomString', () => {
     it('generates a random string with the length between the two inputs', () => {
       const sut = randomString(10, 20)