interface-forge - v2.5.0
    Preparing search index...

    Class NumberModule

    Module to generate numbers of any kind.

    For simple integers, use int(). For decimal/floating-point numbers, use float().

    For numbers not in base-10, you can use hex(), octal() and binary()`.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    bigInt binary float hex int octal romanNumeral

    Constructors

    Properties

    faker: SimpleFaker

    Methods

    • Returns a BigInt number. The bounds are inclusive.

      Parameters

      • Optionaloptions:
            | string
            | number
            | bigint
            | boolean
            | {
                max?: string
                | number
                | bigint
                | boolean;
                min?: string | number | bigint | boolean;
                multipleOf?: string | number | bigint | boolean;
            }

        Maximum value or options object.

        • string
        • number
        • bigint
        • boolean
        • {
              max?: string | number | bigint | boolean;
              min?: string | number | bigint | boolean;
              multipleOf?: string | number | bigint | boolean;
          }
          • Optionalmax?: string | number | bigint | boolean

            Upper bound for generated bigint.

            min + 999999999999999n
          • Optionalmin?: string | number | bigint | boolean

            Lower bound for generated bigint.

            0n
          • OptionalmultipleOf?: string | number | bigint | boolean

            The generated bigint will be a multiple of this parameter.

            1n

      Returns bigint

      When min is greater than max.

      When there are no suitable bigint between min and max.

      When multipleOf is not a positive bigint.

      faker.number.bigInt() // 55422n
      faker.number.bigInt(100n) // 52n
      faker.number.bigInt({ min: 1000000n }) // 431433n
      faker.number.bigInt({ max: 100n }) // 42n
      faker.number.bigInt({ multipleOf: 7n }) // 35n
      faker.number.bigInt({ min: 10n, max: 100n }) // 36n

      8.0.0

    • Returns a binary number. The bounds are inclusive.

      Parameters

      • Optionaloptions: number | { max?: number; min?: number }

        Maximum value or options object.

        • number
        • { max?: number; min?: number }
          • Optionalmax?: number

            Upper bound for generated number.

            1
          • Optionalmin?: number

            Lower bound for generated number.

            0

      Returns string

      When min is greater than max.

      When there are no integers between min and max.

      faker.string.binary(): For generating a binary string with a given length (range).

      faker.number.binary() // '1'
      faker.number.binary(255) // '110101'
      faker.number.binary({ min: 0, max: 65535 }) // '10110101'

      8.0.0

    • 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.

      Parameters

      • Optionaloptions:
            | number
            | {
                fractionDigits?: number;
                max?: number;
                min?: number;
                multipleOf?: number;
            }

        Upper bound or options object.

        • number
        • { fractionDigits?: number; max?: number; min?: number; multipleOf?: number }
          • OptionalfractionDigits?: 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.

          • Optionalmax?: number

            Upper bound for generated number, exclusive, unless multipleOf or fractionDigits are passed.

            1.0
          • Optionalmin?: number

            Lower bound for generated number, inclusive.

            0.0
          • OptionalmultipleOf?: number

            The generated number will be a multiple of this parameter. Only one of multipleOf or fractionDigits should be passed.

      Returns number

      When min is greater than max.

      When multipleOf is not a positive number.

      When fractionDigits is negative.

      When fractionDigits and multipleOf is passed in the same options object.

      faker.number.float() // 0.5688541042618454
      faker.number.float(3) // 2.367973240558058
      faker.number.float({ max: 100 }) // 17.3687307164073
      faker.number.float({ min: 20, max: 30 }) // 23.94764115102589
      faker.number.float({ multipleOf: 0.25, min: 0, max:10 }) // 7.75
      faker.number.float({ fractionDigits: 1 }) // 0.9
      faker.number.float({ min: 10, max: 100, multipleOf: 0.02 }) // 35.42
      faker.number.float({ min: 10, max: 100, fractionDigits: 3 }) // 65.716
      faker.number.float({ min: 10, max: 100, multipleOf: 0.001 }) // 65.716 - same as above

      8.0.0

    • Returns a lowercase hexadecimal number. The bounds are inclusive.

      Parameters

      • Optionaloptions: number | { max?: number; min?: number }

        Maximum value or options object.

        • number
        • { max?: number; min?: number }
          • Optionalmax?: number

            Upper bound for generated number.

            15
          • Optionalmin?: number

            Lower bound for generated number.

            0

      Returns string

      When min is greater than max.

      When there are no integers between min and max.

      faker.number.hex() // 'b'
      faker.number.hex(255) // '9d'
      faker.number.hex({ min: 0, max: 65535 }) // 'af17'

      8.0.0

    • Returns a single random integer between zero and the given max value or the given range. The bounds are inclusive.

      Parameters

      • Optionaloptions: number | { max?: number; min?: number; multipleOf?: number }

        Maximum value or options object.

        • number
        • { max?: number; min?: number; multipleOf?: number }
          • Optionalmax?: number

            Upper bound for generated number.

            Number.MAX_SAFE_INTEGER
          • Optionalmin?: number

            Lower bound for generated number.

            0
          • OptionalmultipleOf?: number

            Generated number will be a multiple of the given integer.

            1

      Returns number

      When min is greater than max.

      When there are no suitable integers between min and max.

      When multipleOf is not a positive integer.

      faker.string.numeric(): For generating a string of digits with a given length (range).

      faker.number.int() // 2900970162509863
      faker.number.int(100) // 52
      faker.number.int({ min: 1000000 }) // 2900970162509863
      faker.number.int({ max: 100 }) // 42
      faker.number.int({ min: 10, max: 100 }) // 57
      faker.number.int({ min: 10, max: 100, multipleOf: 10 }) // 50

      8.0.0

    • Returns an octal number. The bounds are inclusive.

      Parameters

      • Optionaloptions: number | { max?: number; min?: number }

        Maximum value or options object.

        • number
        • { max?: number; min?: number }
          • Optionalmax?: number

            Upper bound for generated number.

            7
          • Optionalmin?: number

            Lower bound for generated number.

            0

      Returns string

      When min is greater than max.

      When there are no integers between min and max.

      faker.string.octal(): For generating an octal string with a given length (range).

      faker.number.octal() // '5'
      faker.number.octal(255) // '377'
      faker.number.octal({ min: 0, max: 65535 }) // '4766'

      8.0.0

    • Returns a roman numeral in String format. The bounds are inclusive.

      Parameters

      • Optionaloptions: number | { max?: number; min?: number }

        Maximum value or options object.

        • number
        • { max?: number; min?: number }
          • Optionalmax?: number

            Upper bound for generated number.

            3999
          • Optionalmin?: number

            Lower bound for generated number.

            1

      Returns string

      When min is greater than max.

      When min, max is not a number.

      When min is less than 1.

      When max is greater than 3999.

      faker.number.romanNumeral() // "CMXCIII"
      faker.number.romanNumeral(5) // "III"
      faker.number.romanNumeral({ min: 10 }) // "XCIX"
      faker.number.romanNumeral({ max: 20 }) // "XVII"
      faker.number.romanNumeral({ min: 5, max: 10 }) // "VII"

      9.2.0

    Settings

    Member Visibility

    On This Page

    OverviewRelated modules
    Constructors
    Properties
    Methods