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/random | |
| parent | 7ce8c285cb5b2d13e95a17be78ecbd52f3c7d9db (diff) | |
| download | faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.tar.xz faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.zip | |
test(docs): ensure defaults are consistent (#2177)
Diffstat (limited to 'src/modules/random')
| -rw-r--r-- | src/modules/random/index.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts index 98d28bc5..997583c1 100644 --- a/src/modules/random/index.ts +++ b/src/modules/random/index.ts @@ -215,7 +215,7 @@ export class RandomModule extends ModuleBase { /** * Generating a string consisting of letters in the English alphabet. * - * @param options Either the number of characters or an options instance. Defaults to `{ count: 1, casing: 'mixed', bannedChars: [] }`. + * @param options Either the number of characters or an options instance. * @param options.count The number of characters to generate. Defaults to `1`. * @param options.casing The casing of the characters. Defaults to `'mixed'`. * @param options.bannedChars An array with characters to exclude. Defaults to `[]`. @@ -276,7 +276,7 @@ export class RandomModule extends ModuleBase { * Generating a string consisting of alpha characters and digits. * * @param count The number of characters and digits to generate. Defaults to `1`. - * @param options The options to use. Defaults to `{ bannedChars: [] }`. + * @param options The options to use. * @param options.casing The casing of the characters. Defaults to `'lower'`. * @param options.bannedChars An array of characters and digits which should be banned in the generated string. Defaults to `[]`. * @@ -325,7 +325,7 @@ export class RandomModule extends ModuleBase { * Generates a given length string of digits. * * @param length The number of digits to generate. Defaults to `1`. - * @param options The options to use. Defaults to `{}`. + * @param options The options to use. * @param options.allowLeadingZeros Whether leading zeros are allowed or not. Defaults to `true`. * @param options.bannedDigits An array of digits which should be banned in the generated string. Defaults to `[]`. * |
