Number

Module to generate numbers of any kind.

Overview
For simple integers, use {{$number.int}}. For decimal/floating-point numbers, use {{$number.float}}.

For numbers not in base-10, you can use {{number.octal}}and{{$number.binary}}`.

Related modules
For numeric strings of a given length, use {{$string.numeric}}.
For credit card numbers, use {{$finance.creditCardNumber}}.

bigInt

Returns a BigInt number. The bounds are inclusive.

Parameters

Name	Type	Default	Description
max	string \| number \| bigint \|	`min + 999999999999999n`	Upper bound for generated bigint.
min	string \| number \| bigint \|	`0n`	Lower bound for generated bigint.

Returns: bigint

Examples

binary

Returns a binary number. The bounds are inclusive.

Parameters

Name	Type	Default	Description
max	string \| number \| bigint \|	`1`	Upper bound for generated number.
min	string \| number \| bigint \|	`0`	Lower bound for generated number.

Returns: string

Examples

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.

Parameters

Name	Type	Default	Description
fractionDigits	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
max	number	`1.0`	Upper bound for generated number, exclusive, unless `multipleOf` or `fractionDigits` are passed.
max	number	`0.0`	Lower bound for generated number, inclusive.
multipleOf	number		The generated number will be a multiple of this parameter. Only one of `multipleOf` or `fractionDigits` should be passed.

Returns: number

Examples

hex

Returns a lowercase hexadecimal number. The bounds are inclusive.

Parameters

Name	Type	Default	Description
max	number	`15`	Upper bound for generated number
max	number	`0`	Lower bound for generated number

Returns: string

Examples

int

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

Parameters

Name	Type	Default	Description
max	number	`Number.MAX_SAFE_INTEGER`	Upper bound for generated number
max	number	`0`	Lower bound for generated number
multipleOf	number	`1`	Generated number will be a multiple of the given integer.

Returns: number

Examples

octal

Returns an octal number. The bounds are inclusive.

Parameters

Name	Type	Default	Description
max	number	`7`	Upper bound for generated number
max	number	`0`	Lower bound for generated number

Returns: string

Examples

bigInt#

binary#

float#

hex#

int#

octal#

bigInt

binary

float

hex

int

octal