Method float

src/modules/number/index.ts:146–236

* Returns a single random floating-point number, by default between `0.0` and `1.0`. To change the range, pass a `min` and `max` value. To limit the number of decimal places, pass a `multipleOf` or `fractionDigits` parameter. * * @param options Upper bound or options object. * @param option

(
    options:
      | number
      | {
          /**
           * Lower bound for generated number, inclusive.
           *
           * @default 0.0
           */
          min?: number;
          /**
           * Upper bound for generated number, exclusive, unless `multipleOf` or `fractionDigits` are passed.
           *
           * @default 1.0
           */
          max?: number;
          /**
           * The maximum number of digits to appear after the decimal point, for example `2` will round to 2 decimal points. Only one of `multipleOf` or `fractionDigits` should be passed.
           */
          fractionDigits?: number;
          /**
           * The generated number will be a multiple of this parameter. Only one of `multipleOf` or `fractionDigits` should be passed.
           */
          multipleOf?: number;
          /**
           * A function to determine the distribution of generated values.
           *
           * @default uniformDistributor()
           */
          distributor?: Distributor;
        } = {}
  )

   * @since 8.0.0
   */
  float(
    options:
      | number
      | {
          /**
           * Lower bound for generated number, inclusive.
           *
           * @default 0.0
           */
          min?: number;
          /**
           * Upper bound for generated number, exclusive, unless `multipleOf` or `fractionDigits` are passed.
           *
           * @default 1.0
           */
          max?: number;
          /**
           * The maximum number of digits to appear after the decimal point, for example `2` will round to 2 decimal points. Only one of `multipleOf` or `fractionDigits` should be passed.
           */
          fractionDigits?: number;
          /**
           * The generated number will be a multiple of this parameter. Only one of `multipleOf` or `fractionDigits` should be passed.
           */
          multipleOf?: number;
          /**
           * A function to determine the distribution of generated values.
           *
           * @default uniformDistributor()
           */
          distributor?: Distributor;
        } = {}
  ): number {
    if (typeof options === 'number') {
      options = {
        max: options,
      };
    }

    const {
      min = 0,
      max = 1,
      fractionDigits,
      multipleOf: originalMultipleOf,
      multipleOf = fractionDigits == null ? undefined : 10 ** -fractionDigits,
      distributor = uniformDistributor(),
    } = options;

    if (max < min) {
      throw new FakerError(`Max ${max} should be greater than min ${min}.`);
    }

    if (fractionDigits != null) {
      if (originalMultipleOf != null) {
        throw new FakerError(
          'multipleOf and fractionDigits cannot be set at the same time.'
        );
      }