feat(number): add parameter fractionDigits in float

src/modules/color/index.ts

@@ -379,7 +379,7 @@ export class ColorModule {
 
     color = Array.from({ length: 3 }, () => this.faker.number.int(255));
     if (includeAlpha) {
-      color.push(this.faker.number.float({ precision: 0.01 }));
+      color.push(this.faker.number.float({ fractionDigits: 2 }));
       cssFunction = 'rgba';
     }
 
@@ -460,7 +460,7 @@ export class ColorModule {
   }): string | number[];
   cmyk(options?: { format?: ColorFormat }): string | number[] {
     const color: string | number[] = Array.from({ length: 4 }, () =>
-      this.faker.number.float({ precision: 0.01 })
+      this.faker.number.float({ fractionDigits: 2 })
     );
     return toColorFormat(color, options?.format || 'decimal', 'cmyk');
   }
@@ -570,7 +570,7 @@ export class ColorModule {
   }): string | number[] {
     const hsl: number[] = [this.faker.number.int(360)];
     for (let i = 0; i < (options?.includeAlpha ? 3 : 2); i++) {
-      hsl.push(this.faker.number.float({ precision: 0.01 }));
+      hsl.push(this.faker.number.float({ fractionDigits: 2 }));
     }
 
     return toColorFormat(
@@ -676,7 +676,7 @@ export class ColorModule {
   }): string | number[] {
     const hsl: number[] = [this.faker.number.int(360)];
     for (let i = 0; i < 2; i++) {
-      hsl.push(this.faker.number.float({ precision: 0.01 }));
+      hsl.push(this.faker.number.float({ fractionDigits: 2 }));
     }
 
     return toColorFormat(hsl, options?.format || 'decimal', 'hwb');
@@ -755,10 +755,10 @@ export class ColorModule {
     format?: ColorFormat;
   }): string | number[];
   lab(options?: { format?: ColorFormat }): string | number[] {
-    const lab = [this.faker.number.float({ precision: 0.000001 })];
+    const lab = [this.faker.number.float({ fractionDigits: 6 })];
     for (let i = 0; i < 2; i++) {
       lab.push(
-        this.faker.number.float({ min: -100, max: 100, precision: 0.0001 })
+        this.faker.number.float({ min: -100, max: 100, fractionDigits: 4 })
       );
     }
 
@@ -850,9 +850,9 @@ export class ColorModule {
     format?: ColorFormat;
   }): string | number[];
   lch(options?: { format?: ColorFormat }): string | number[] {
-    const lch = [this.faker.number.float({ precision: 0.000001 })];
+    const lch = [this.faker.number.float({ fractionDigits: 6 })];
     for (let i = 0; i < 2; i++) {
-      lch.push(this.faker.number.float({ max: 230, precision: 0.1 }));
+      lch.push(this.faker.number.float({ max: 230, fractionDigits: 1 }));
     }
 
     return toColorFormat(lch, options?.format || 'decimal', 'lch');
@@ -960,7 +960,7 @@ export class ColorModule {
     }
 
     const color = Array.from({ length: 3 }, () =>
-      this.faker.number.float({ precision: 0.0001 })
+      this.faker.number.float({ fractionDigits: 4 })
     );
     return toColorFormat(
       color,

src/modules/datatype/index.ts

@@ -1,6 +1,56 @@
 import type { Faker } from '../..';
+import { FakerError } from '../../errors/faker-error';
 import { deprecated } from '../../internal/deprecated';
 
+/**
+ * The legcy implementation for datatype float.
+ *
+ * @param options An options object.
+ * @param options.min Lower bound for generated number. Defaults to `0`.
+ * @param options.max Upper bound for generated number. Defaults to `min + 99999`.
+ * @param options.faker A faker instance.
+ * @param options.precision Precision of the generated number. Defaults to `0.01`.
+ *
+ */
+function legacyFloatImplementation(options: {
+  /**
+   * A faker instance.
+   */
+  faker: Faker;
+  /**
+   * Lower bound for generated number.
+   */
+  min: number;
+  /**
+   * Upper bound for generated number.
+   */
+  max: number;
+  /**
+   * Precision of the generated number.
+   */
+  precision: number;
+}) {
+  const { max, min, precision, faker } = options;
+  if (max === min) {
+    return min;
+  }
+
+  if (max < min) {
+    throw new FakerError(`Max ${max} should be greater than min ${min}.`);
+  }
+
+  if (precision <= 0) {
+    throw new FakerError(`Precision should be greater than 0.`);
+  }
+
+  const factor = 1 / precision;
+  const int = faker.number.int({
+    min: min * factor,
+    max: max * factor,
+  });
+  return int / factor;
+}
+
 /**
  * Module to generate various primitive values and data types.
  */
@@ -81,7 +131,12 @@ export class DatatypeModule {
 
     const { min = 0, max = min + 99999, precision = 1 } = options;
 
-    return this.faker.number.float({ min, max, precision });
+    return legacyFloatImplementation({
+      faker: this.faker,
+      max,
+      min,
+      precision,
+    });
   }
 
   /**
@@ -145,7 +200,12 @@ export class DatatypeModule {
 
     const { min = 0, max = min + 99999, precision = 0.01 } = options;
 
-    return this.faker.number.float({ min, max, precision });
+    return legacyFloatImplementation({
+      faker: this.faker,
+      max,
+      min,
+      precision,
+    });
   }
 
   /**

src/modules/finance/index.ts

@@ -543,7 +543,7 @@ export class FinanceModule {
     const randValue = this.faker.number.float({
       max,
       min,
-      precision: 10 ** -dec,
+      fractionDigits: dec,
     });
 
     let formattedString: string;

src/modules/helpers/index.ts

@@ -544,7 +544,7 @@ export class HelpersModule {
     const random = this.faker.number.float({
       min: 0,
       max: total,
-      precision: 1e-9,
+      fractionDigits: 9,
     });
     let current = 0;
     for (const { weight, value } of array) {

src/modules/location/index.ts

@@ -476,7 +476,7 @@ export class LocationModule {
 
     const { max = 90, min = legacyMin, precision = legacyPrecision } = options;
 
-    return this.faker.number.float({ min, max, precision: 10 ** -precision });
+    return this.faker.number.float({ min, max, fractionDigits: precision });
   }
 
   /**
@@ -629,7 +629,7 @@ export class LocationModule {
 
     const { max = 180, min = legacyMin, precision = legacyPrecision } = options;
 
-    return this.faker.number.float({ max, min, precision: 10 ** -precision });
+    return this.faker.number.float({ max, min, fractionDigits: precision });
   }
 
   /**
@@ -873,15 +873,15 @@ export class LocationModule {
 
     const angleRadians = this.faker.number.float({
       max: 2 * Math.PI,
-      precision: 0.00001,
+      fractionDigits: 5,
     }); // in ° radians
 
     const radiusMetric = isMetric ? radius : radius * 1.60934; // in km
     const errorCorrection = 0.995; // avoid float issues
     const distanceInKm =
       this.faker.number.float({
         max: radiusMetric,
-        precision: 0.001,
+        fractionDigits: 3,
       }) * errorCorrection; // in km
 
     /**

src/modules/number/index.ts

@@ -93,15 +93,18 @@ export class NumberModule {
    * @param options Upper bound or options object. Defaults to `{}`.
    * @param options.min Lower bound for generated number. Defaults to `0.0`.
    * @param options.max Upper bound for generated number. Defaults to `1.0`.
-   * @param options.precision Precision of the generated number, for example `0.01` will round to 2 decimal points.
+   * @param options.fractionDigits The number of digits to appear after the decimal point. Defaults to `16`.
+   *
+   * @throws If options.max is smaller than options.min.
+   * @throws If options.fractionDigits is negative.
    *
    * @example
    * faker.number.float() // 0.5688541042618454
    * faker.number.float(3) // 2.367973240558058
    * faker.number.float({ min: -1000000 }) //-780678.849672846
    * faker.number.float({ max: 100 }) // 17.3687307164073
-   * faker.number.float({ precision: 0.1 }) // 0.9
-   * faker.number.float({ min: 10, max: 100, precision: 0.001 }) // 35.415
+   * faker.number.float({ fractionDigits: 1 }) // 0.9
+   * faker.number.float({ min: 10, max: 100, fractionDigits: 3 }) // 35.415
    *
    * @since 8.0.0
    */
@@ -122,11 +125,11 @@ export class NumberModule {
            */
           max?: number;
           /**
-           * Precision of the generated number.
+           * The number of digits to appear after the decimal point.
            *
-           * @default 0.01
+           * @default 16
            */
-          precision?: number;
+          fractionDigits?: number;
         } = {}
   ): number {
     if (typeof options === 'number') {
@@ -135,7 +138,7 @@ export class NumberModule {
       };
     }
 
-    const { min = 0, max = 1, precision } = options;
+    const { min = 0, max = 1, fractionDigits = 16 } = options;
 
     if (max === min) {
       return min;
@@ -145,23 +148,17 @@ export class NumberModule {
       throw new FakerError(`Max ${max} should be greater than min ${min}.`);
     }
 
-    if (precision !== undefined) {
-      if (precision <= 0) {
-        throw new FakerError(`Precision should be greater than 0.`);
-      }
-
-      const factor = 1 / precision;
-      const int = this.int({
-        min: min * factor,
-        max: max * factor,
-      });
-      return int / factor;
-    } else {
-      // @ts-expect-error: access private member field
-      const mersenne: Mersenne = this.faker._mersenne;
-      const real = mersenne.next();
-      return real * (max - min) + min;
+    if (fractionDigits < 0) {
+      throw new FakerError(
+        'The fractional digits count should be greater than 0.'
+      );
     }
+
+    // @ts-expect-error: access private member field
+    const mersenne: Mersenne = this.faker._mersenne;
+    const real = mersenne.next() * (max - min) + min;
+
+    return parseFloat(real.toFixed(fractionDigits));
   }
 
   /**