aboutsummaryrefslogtreecommitdiff
path: root/src/modules/number/index.ts
diff options
context:
space:
mode:
authorAn Nguyen <[email protected]>2023-05-25 00:29:56 -0700
committerGitHub <[email protected]>2023-05-25 09:29:56 +0200
commitf901e3d48d51c09d253893bbc2099c4ef1b9dd2c (patch)
tree156ef417640330a6f704055e16dd19d91ce759c1 /src/modules/number/index.ts
parentb6005475c046f88addad5e77315c6f8a01ec6e79 (diff)
downloadfaker-f901e3d48d51c09d253893bbc2099c4ef1b9dd2c.tar.xz
faker-f901e3d48d51c09d253893bbc2099c4ef1b9dd2c.zip
docs(number): update default max value (#2176)
Diffstat (limited to 'src/modules/number/index.ts')
-rw-r--r--src/modules/number/index.ts6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/number/index.ts b/src/modules/number/index.ts
index 524b69d5..fce3829a 100644
--- a/src/modules/number/index.ts
+++ b/src/modules/number/index.ts
@@ -43,9 +43,9 @@ export class NumberModule {
* @see faker.string.numeric() If you would like to generate a `string` of digits with a given length (range).
*
* @example
- * faker.number.int() // 55422
+ * faker.number.int() // 2900970162509863
* faker.number.int(100) // 52
- * faker.number.int({ min: 1000000 }) // 1031433
+ * faker.number.int({ min: 1000000 }) // 2900970162509863
* faker.number.int({ max: 100 }) // 42
* faker.number.int({ min: 10, max: 100 }) // 57
*
@@ -64,7 +64,7 @@ export class NumberModule {
/**
* Upper bound for generated number.
*
- * @default min + 99999
+ * @default Number.MAX_SAFE_INTEGER
*/
max?: number;
} = {}