number Domain
The number domain maps domain keywords to underlying faker implementations.
Faker Documentation
Methods
number.bigInt
Returns a BigInt number.
- Canonical:
awd.domain.number.bigInt - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
min | integer | no | Optional minimum bound for the generated BigInt value. |
max | integer | no | Optional maximum bound for the generated BigInt value. |
multipleOf | integer | no | Generated BigInt will be a multiple of the given value. |
Examples:
Shows number.bigInt with all optional params omitted.
number.bigInt()
Returns: 703101335462806n
Shows number.bigInt using min and max bounds.
number.bigInt(min=100, max=1000)
Returns: 570n
Shows number.bigInt constrained to a multiple.
number.bigInt(multipleOf=7)
Returns: 292170934823957n
Shows number.bigInt using an upper bound.
number.bigInt(max=1000)
Returns: 699n
number.binary
Returns a binary string.
- Canonical:
awd.domain.number.binary - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
max | number | no | Upper bound for generated number. |
min | number | no | Lower bound for generated number. |
Examples:
Shows number.binary when optional params are omitted.
number.binary()
Returns: 0
Shows number.binary using max.
number.binary(max=5)
Returns: 10
Shows number.binary using min.
number.binary(max=10, min=1)
Returns: 101
number.float
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.
- Canonical:
awd.domain.number.float - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
fractionDigits | integer | no | 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. |
max | number | no | Upper bound for generated number, exclusive, unless multipleOf or fractionDigits are passed. |
min | number | no | Lower bound for generated number, inclusive. |
multipleOf | number | no | The generated number will be a multiple of this parameter. Only one of multipleOf or fractionDigits should be passed. |
Examples:
Shows number.float with all optional params omitted.
number.float()
Returns: 0.417022004702574
Shows number.float rounding using only fractionDigits.
number.float(fractionDigits=2)
Returns: 0.42
Shows number.float constrained using only multipleOf.
number.float(multipleOf=0.5)
Returns: 0.5
Shows number.float with an explicit numeric range.
number.float(min=1, max=10)
Returns: 4.753198042323167
Shows number.float rounding with fractionDigits.
number.float(min=1, max=10, fractionDigits=2)
Returns: 4.75
Shows number.float constrained to a multiple.
number.float(min=1, max=10, multipleOf=0.5)
Returns: 4.5
Shows number.float using only an upper bound.
number.float(max=10)
Returns: 4.17022004702574
number.hex
Returns a lowercase hexadecimal number.
- Canonical:
awd.domain.number.hex - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
min | number | no | Minimum bound used when generating a value. |
max | number | no | Maximum bound used when generating a value. |
Examples:
Shows number.hex when optional params are omitted.
number.hex()
Returns: 6
Shows number.hex using min.
number.hex(max=10, min=1)
Returns: 5
Shows number.hex using max.
number.hex(max=5)
Returns: 2
number.int
Returns a single random integer between zero and the given max value or the given range.
- Canonical:
awd.domain.number.int - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
min | number | no | Optional minimum integer. |
max | number | no | Optional maximum integer. |
multipleOf | number | no | Generated number will be a multiple of the given integer. |
Examples:
Shows number.int when optional params are omitted.
number.int()
Returns: 3756200289967619
Shows number.int using min.
number.int(max=10, min=1)
Returns: 5
Shows number.int using max.
number.int(max=5)
Returns: 2
Shows number.int using multipleOf.
number.int(multipleOf=1)
Returns: 3756200289967619
number.octal
Returns an octal string.
- Canonical:
awd.domain.number.octal - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
max | number | no | Upper bound for generated number. |
min | number | no | Lower bound for generated number. |
Examples:
Shows number.octal when optional params are omitted.
number.octal()
Returns: 3
Shows number.octal using max.
number.octal(max=5)
Returns: 2
Shows number.octal using min.
number.octal(max=10, min=1)
Returns: 5
number.romanNumeral
Returns a roman numeral in String format.
- Canonical:
awd.domain.number.romanNumeral - Faker docs: https://fakerjs.dev/api/number
| Arg | Type | Required | Description |
|---|---|---|---|
min | number | no | Minimum bound used when generating a value. |
max | number | no | Maximum bound used when generating a value. |
Examples:
Shows number.romanNumeral when optional params are omitted.
number.romanNumeral()
Returns: MDCLXVIII
Shows number.romanNumeral using min.
number.romanNumeral(max=10, min=1)
Returns: V
Shows number.romanNumeral using max.
number.romanNumeral(max=5)
Returns: III