aboutsummaryrefslogtreecommitdiff
path: root/src/modules/number
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-11-13 09:20:17 +0100
committerGitHub <[email protected]>2023-11-13 08:20:17 +0000
commita747854d6b5d4db5c02ff344b8abb322c6ceac99 (patch)
treedd1b53816d9c6ba3986ed85b001dbdcd68111f4b /src/modules/number
parent7ce8c285cb5b2d13e95a17be78ecbd52f3c7d9db (diff)
downloadfaker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.tar.xz
faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.zip
test(docs): ensure defaults are consistent (#2177)
Diffstat (limited to 'src/modules/number')
-rw-r--r--src/modules/number/index.ts12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/modules/number/index.ts b/src/modules/number/index.ts
index 85272aff..de32af25 100644
--- a/src/modules/number/index.ts
+++ b/src/modules/number/index.ts
@@ -20,7 +20,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns a single random integer between zero and the given max value or the given range.
* The bounds are inclusive.
*
- * @param options Maximum value or options object. Defaults to `{}`.
+ * @param options Maximum value or options object.
* @param options.min Lower bound for generated number. Defaults to `0`.
* @param options.max Upper bound for generated number. Defaults to `Number.MAX_SAFE_INTEGER`.
*
@@ -87,7 +87,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns a single random floating-point number for a given precision or range and precision.
* The lower bound is inclusive, the upper bound is exclusive, unless precision is passed.
*
- * @param options Upper bound or options object. Defaults to `{}`.
+ * @param options Upper bound or options object.
* @param options.min Lower bound for generated number. Defaults to `0.0`.
* @param options.max Upper bound for generated number. Defaults to `1.0`.
* @param options.precision Precision of the generated number, for example `0.01` will round to 2 decimal points.
@@ -164,7 +164,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns a [binary](https://en.wikipedia.org/wiki/Binary_number) number.
* The bounds are inclusive.
*
- * @param options Maximum value or options object. Defaults to `{}`.
+ * @param options Maximum value or options object.
* @param options.min Lower bound for generated number. Defaults to `0`.
* @param options.max Upper bound for generated number. Defaults to `1`.
*
@@ -213,7 +213,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns an [octal](https://en.wikipedia.org/wiki/Octal) number.
* The bounds are inclusive.
*
- * @param options Maximum value or options object. Defaults to `{}`.
+ * @param options Maximum value or options object.
* @param options.min Lower bound for generated number. Defaults to `0`.
* @param options.max Upper bound for generated number. Defaults to `7`.
*
@@ -262,7 +262,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns a lowercase [hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) number.
* The bounds are inclusive.
*
- * @param options Maximum value or options object. Defaults to `{}`.
+ * @param options Maximum value or options object.
* @param options.min Lower bound for generated number. Defaults to `0`.
* @param options.max Upper bound for generated number. Defaults to `15`.
*
@@ -309,7 +309,7 @@ export class NumberModule extends SimpleModuleBase {
* Returns a [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#bigint_type) number.
* The bounds are inclusive.
*
- * @param options Maximum value or options object. Defaults to `{}`.
+ * @param options Maximum value or options object.
* @param options.min Lower bound for generated bigint. Defaults to `0n`.
* @param options.max Upper bound for generated bigint. Defaults to `min + 999999999999999n`.
*