diff options
| author | ST-DDT <[email protected]> | 2023-11-13 09:20:17 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-11-13 08:20:17 +0000 |
| commit | a747854d6b5d4db5c02ff344b8abb322c6ceac99 (patch) | |
| tree | dd1b53816d9c6ba3986ed85b001dbdcd68111f4b /src/modules/datatype | |
| parent | 7ce8c285cb5b2d13e95a17be78ecbd52f3c7d9db (diff) | |
| download | faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.tar.xz faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.zip | |
test(docs): ensure defaults are consistent (#2177)
Diffstat (limited to 'src/modules/datatype')
| -rw-r--r-- | src/modules/datatype/index.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/datatype/index.ts b/src/modules/datatype/index.ts index a8b77a2c..ad0b5489 100644 --- a/src/modules/datatype/index.ts +++ b/src/modules/datatype/index.ts @@ -15,7 +15,7 @@ export class DatatypeModule extends SimpleModuleBase { * Returns a single random number between zero and the given max value or the given range with the specified precision. * The bounds are inclusive. * - * @param options Maximum value or options object. + * @param options Maximum value or options object. Defaults to `99999`. * @param options.min Lower bound for generated number. Defaults to `0`. * @param options.max Upper bound for generated number. Defaults to `min + 99999`. * @param options.precision Precision of the generated number. Defaults to `1`. @@ -213,7 +213,7 @@ export class DatatypeModule extends SimpleModuleBase { /** * Returns a string containing UTF-16 chars between 33 and 125 (`!` to `}`). * - * @param options Length of the generated string or an options object. Defaults to `{}`. + * @param options Length of the generated string or an options object. * @param options.length Length of the generated string. Max length is `2^20`. Defaults to `10`. * * @see faker.string.sample() @@ -285,7 +285,7 @@ export class DatatypeModule extends SimpleModuleBase { * If the probability is `>= 1.0`, it will always return `true`. * The probability is limited to two decimal places. * - * @param options The optional options object or the probability (`[0.00, 1.00]`) of returning `true`. Defaults to `0.5`. + * @param options The optional options object or the probability (`[0.00, 1.00]`) of returning `true`. * @param options.probability The probability (`[0.00, 1.00]`) of returning `true`. Defaults to `0.5`. * * @example |
