From 9cd716e891d3bb8d9a8f9d43899d0dcd161e1832 Mon Sep 17 00:00:00 2001
From: ST-DDT <ST-DDT@gmx.de>
Date: Mon, 21 Nov 2022 17:55:32 +0100
Subject: feat(helpers): add rangeToNumber method and add range parameters
 (#1486)

---
 src/modules/helpers/index.ts | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'src/modules/helpers')

diff --git a/src/modules/helpers/index.ts b/src/modules/helpers/index.ts
index 7da4fbc8..406f7f19 100644
--- a/src/modules/helpers/index.ts
+++ b/src/modules/helpers/index.ts
@@ -627,6 +627,26 @@ export class HelpersModule {
     return this.fake(res);
   }
 
+  /**
+   * Helper method that converts the given number or range to a number.
+   *
+   * @param numberOrRange The number or range to convert.
+   * @param numberOrRange.min The minimum value for the range.
+   * @param numberOrRange.max The maximum value for the range.
+   *
+   * @example
+   * faker.helpers.rangeToNumber(1) // 1
+   * faker.helpers.rangeToNumber({ min: 1, max: 10 }) // 5
+   *
+   * @since 8.0.0
+   */
+  rangeToNumber(numberOrRange: number | { min: number; max: number }): number {
+    if (typeof numberOrRange === 'number') {
+      return numberOrRange;
+    }
+    return this.faker.datatype.number(numberOrRange);
+  }
+
   /**
    * Generates a unique result using the results of the given method.
    * Used unique entries will be stored internally and filtered from subsequent calls.
-- 
cgit v1.2.3