diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md index 8dc353d120c..d20a311362a 100644 --- a/docs/guide/upgrading.md +++ b/docs/guide/upgrading.md @@ -284,12 +284,14 @@ By default, `faker.number.float` no longer defaults to a precision of 0.01 ```js // OLD +faker.datatype.number(); // 88999 (NOTE: The default max was 99999) faker.datatype.number({ max: 100 }); // 35 faker.datatype.number({ max: 100, precision: 0.01 }); // 35.21 faker.datatype.float({ max: 100 }); // 35.21 faker.datatype.float({ max: 100, precision: 0.001 }); // 35.211 // NEW +faker.number.int({ max: 99999 }); // 88999 (NOTE: the default max is now Number.MAX_SAFE_INTEGER) faker.number.int({ max: 100 }); // 35 faker.number.float({ max: 100 }); // 35.21092065742612 faker.number.float({ max: 100, precision: 0.01 }); // 35.21 diff --git a/src/modules/number/index.ts b/src/modules/number/index.ts index 524b69d51e9..fce3829a72e 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; } = {}