number Domain

The number domain maps domain keywords to underlying faker implementations.

Faker Documentation

• https://fakerjs.dev/api/number

Methods

number.bigInt

Returns a BigInt number.

• Canonical: awd.domain.number.bigInt
• Faker docs: https://fakerjs.dev/api/number

Arg	Type	Required	Description
value	string|number|boolean	no	Legacy placeholder argument from Faker signatures; currently has no effect. Use documented options instead.

Examples:

number.bigInt()

number.bigInt(value=42)

Example return values:

• "347465151663036n"
• "918273645546372n"

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:

number.binary()

number.binary(max=1, min=1)

Example return values:

• "0"

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
value	number	no	Legacy placeholder argument from Faker signatures; currently has no effect. Use documented options instead.
fractionDigits	number	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:

number.float()

Type-in examples (named params):

number.float(value=1)

number.float(fractionDigits=1)

number.float(max=1)

number.float(min=1)

number.float(multipleOf=1)

Example return values:

• 0.11027820838106395
• 0.5898499201943372

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.
value	number	no	Legacy placeholder argument from Faker signatures; currently has no effect. Use documented options instead.

Examples:

number.hex()

number.hex(min=1, max=1, value=1)

Example return values:

• "5"
• "7"

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:

number.int()

number.int(min=1, max=1, multipleOf=1)

Example return values:

• 108688750608405
• 4041549375676296

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:

number.octal()

number.octal(max=1, min=1)

Example return values:

• "3"
• "7"

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.
value	number	no	Legacy placeholder argument from Faker signatures; currently has no effect. Use documented options instead.

Examples:

number.romanNumeral()

number.romanNumeral(min=1, max=1, value=1)

Example return values:

• "MLXXXII"
• "DXXXVI"