FakerNumber
Module to generate numbers of any kind.
Overview
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()`.
Related modules
- For numeric strings of a given length, use
faker.string.numeric(). - For credit card numbers, use
faker.finance.creditCardNumber().
bigInt
Returns a BigInt number.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | bigint | boolean | number | string | { ... } | {} | Maximum value or options object. |
| options.max? | bigint | boolean | number | string | min + 999999999999999n | Upper bound for generated bigint. |
| options.min? | bigint | boolean | number | string | 0n | Lower bound for generated bigint. |
Returns: bigint
Throws: When options define max < min.
ts
faker.number.bigInt(options: bigint | boolean | number | string | {
max: bigint | boolean | number | string,
min: bigint | boolean | number | string
} = {}): 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({ min: 10n, max: 100n }) // 36nSource
binary
Returns a binary number.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | number | { ... } | {} | Maximum value or options object. |
| options.max? | number | 1 | Upper bound for generated number. |
| options.min? | number | 0 | Lower bound for generated number. |
Returns: string
Throws: When options define max < min.
ts
faker.number.binary(options: number | {
max: number,
min: number
} = {}): string
faker.number.binary() // '1'
faker.number.binary(255) // '110101'
faker.number.binary({ min: 0, max: 65535 }) // '10110101'See Also
Source
float
Returns a single random floating-point number for a given precision or range and precision.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | number | { ... } | {} | Upper bound or options object. |
| options.max? | number | 1.0 | Upper bound for generated number. |
| options.min? | number | 0.0 | Lower bound for generated number. |
| options.precision? | number | Precision of the generated number. |
Returns: number
ts
faker.number.float(options: number | {
max: number,
min: number,
precision: number
} = {}): number
faker.number.float() // 0.5688541042618454
faker.number.float(3) // 2.367973240558058
faker.number.float({ min: -1000000 }) //-780678.849672846
faker.number.float({ max: 100 }) // 17.3687307164073
faker.number.float({ precision: 0.1 }) // 0.9
faker.number.float({ min: 10, max: 100, precision: 0.001 }) // 35.415Source
hex
Returns a lowercase hexadecimal number.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | number | { ... } | {} | Maximum value or options object. |
| options.max? | number | 15 | Upper bound for generated number. |
| options.min? | number | 0 | Lower bound for generated number. |
Returns: string
ts
faker.number.hex(options: number | {
max: number,
min: number
} = {}): string
faker.number.hex() // 'b'
faker.number.hex(255) // '9d'
faker.number.hex({ min: 0, max: 65535 }) // 'af17'Source
int
Returns a single random integer between zero and the given max value or the given range. The bounds are inclusive.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | number | { ... } | {} | Maximum value or options object. |
| options.max? | number | Number.MAX_SAFE_INTEGER | Upper bound for generated number. |
| options.min? | number | 0 | Lower bound for generated number. |
Returns: number
Throws: When options define max < min.
ts
faker.number.int(options: number | {
max: number,
min: number
} = {}): number
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 }) // 57See Also
Source
octal
Returns an octal number.
Available since v8.0.0
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| options | number | { ... } | {} | Maximum value or options object. |
| options.max? | number | 7 | Upper bound for generated number. |
| options.min? | number | 0 | Lower bound for generated number. |
Returns: string
Throws: When options define max < min.
ts
faker.number.octal(options: number | {
max: number,
min: number
} = {}): string
faker.number.octal() // '5'
faker.number.octal(255) // '377'
faker.number.octal({ min: 0, max: 65535 }) // '4766'