Method int

src/modules/number/index.ts:47–116

* Returns a single random integer between zero and the given max value or the given range. * The bounds are inclusive. * * @param options Maximum value or options object. * @param options.min Lower bound for generated number. Defaults to `0`. * @param options.max Upper bound for gener

(
    options:
      | number
      | {
          /**
           * Lower bound for generated number.
           *
           * @default 0
           */
          min?: number;
          /**
           * Upper bound for generated number.
           *
           * @default Number.MAX_SAFE_INTEGER
           */
          max?: number;
          /**
           * Generated number will be a multiple of the given integer.
           *
           * @default 1
           */
          multipleOf?: number;
          /**
           * A function to determine the distribution of generated values.
           *
           * @default uniformDistributor()
           */
          distributor?: Distributor;
        } = {}
  )

   * @since 8.0.0
   */
  int(
    options:
      | number
      | {
          /**
           * Lower bound for generated number.
           *
           * @default 0
           */
          min?: number;
          /**
           * Upper bound for generated number.
           *
           * @default Number.MAX_SAFE_INTEGER
           */
          max?: number;
          /**
           * Generated number will be a multiple of the given integer.
           *
           * @default 1
           */
          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 = Number.MAX_SAFE_INTEGER,
      multipleOf = 1,
      distributor = uniformDistributor(),
    } = options;

    if (!Number.isInteger(multipleOf)) {
      throw new FakerError(`multipleOf should be an integer.`);
    }

    if (multipleOf <= 0) {
      throw new FakerError(`multipleOf should be greater than 0.`);
    }

    const effectiveMin = Math.ceil(min / multipleOf);
    const effectiveMax = Math.floor(max / multipleOf);

    if (effectiveMin === effectiveMax) {
      return effectiveMin * multipleOf;
    }

    if (effectiveMax < effectiveMin) {
      if (max >= min) {