Skip to content

Commit

Permalink
docs: rephrase throw description for insufficient int range
Browse files Browse the repository at this point in the history
  • Loading branch information
xDivisionByZerox committed Dec 3, 2023
1 parent f0d6fa4 commit 0480a34
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/modules/number/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class NumberModule extends SimpleModuleBase {
* @param options.max Upper bound for generated number. Defaults to `Number.MAX_SAFE_INTEGER`.
*
* @throws When `min` is greater than `max`.
* @throws When `min` and `max` do not provide a sufficient range to generate integers in between them.
* @throws When there are no integers between `min` and `max`.
*
* @see faker.string.numeric(): For generating a `string` of digits with a given length (range).
*
Expand Down Expand Up @@ -173,7 +173,7 @@ export class NumberModule extends SimpleModuleBase {
* @param options.max Upper bound for generated number. Defaults to `1`.
*
* @throws When `min` is greater than `max`.
* @throws When `min` and `max` do not provide a sufficient range to generate integers in between them.
* @throws When there are no integers between `min` and `max`.
*
* @see faker.string.binary(): For generating a `binary string` with a given length (range).
*
Expand Down Expand Up @@ -223,7 +223,7 @@ export class NumberModule extends SimpleModuleBase {
* @param options.max Upper bound for generated number. Defaults to `7`.
*
* @throws When `min` is greater than `max`.
* @throws When `min` and `max` do not provide a sufficient range to generate integers in between them.
* @throws When there are no integers between `min` and `max`.
*
* @see faker.string.octal(): For generating an `octal string` with a given length (range).
*
Expand Down Expand Up @@ -273,7 +273,7 @@ export class NumberModule extends SimpleModuleBase {
* @param options.max Upper bound for generated number. Defaults to `15`.
*
* @throws When `min` is greater than `max`.
* @throws When `min` and `max` do not provide a sufficient range to generate integers in between them.
* @throws When there are no integers between `min` and `max`.
*
* @example
* faker.number.hex() // 'b'
Expand Down

0 comments on commit 0480a34

Please sign in to comment.