aboutsummaryrefslogtreecommitdiff
path: root/src/modules/internet
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/internet
parent7ce8c285cb5b2d13e95a17be78ecbd52f3c7d9db (diff)
downloadfaker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.tar.xz
faker-a747854d6b5d4db5c02ff344b8abb322c6ceac99.zip
test(docs): ensure defaults are consistent (#2177)
Diffstat (limited to 'src/modules/internet')
-rw-r--r--src/modules/internet/index.ts36
1 files changed, 18 insertions, 18 deletions
diff --git a/src/modules/internet/index.ts b/src/modules/internet/index.ts
index 4f58615f..5eb9b4bc 100644
--- a/src/modules/internet/index.ts
+++ b/src/modules/internet/index.ts
@@ -56,7 +56,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates an email address using the given person's name as base.
*
- * @param options The options to use. Defaults to `{}`.
+ * @param options The options to use.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param options.provider The mail provider domain to use. If not specified, a random free mail provider will be chosen.
@@ -101,7 +101,7 @@ export class InternetModule extends ModuleBase {
* @param firstName The optional first name to use. If not specified, a random one will be chosen.
* @param lastName The optional last name to use. If not specified, a random one will be chosen.
* @param provider The mail provider domain to use. If not specified, a random free mail provider will be chosen.
- * @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`.
+ * @param options The options to use.
* @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
* in the email address. Defaults to `false`.
*
@@ -131,7 +131,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates an email address using the given person's name as base.
*
- * @param options The options to use. Defaults to `{}`.
+ * @param options The options to use.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param options.provider The mail provider domain to use. If not specified, a random free mail provider will be chosen.
@@ -139,7 +139,7 @@ export class InternetModule extends ModuleBase {
* in the email address. Defaults to `false`.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
* @param legacyProvider The mail provider domain to use. If not specified, a random free mail provider will be chosen.
- * @param legacyOptions The options to use. Defaults to `{ allowSpecialCharacters: false }`.
+ * @param legacyOptions The options to use.
* @param legacyOptions.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
* in the email address. Defaults to `false`.
*
@@ -287,7 +287,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates an email address using an example mail provider using the given person's name as base.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
@@ -325,7 +325,7 @@ export class InternetModule extends ModuleBase {
*
* @param firstName The optional first name to use. If not specified, a random one will be chosen.
* @param lastName The optional last name to use. If not specified, a random one will be chosen.
- * @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`.
+ * @param options The options to use.
* @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
* in the email address. Defaults to `false`.
*
@@ -353,13 +353,13 @@ export class InternetModule extends ModuleBase {
/**
* Generates an email address using an example mail provider using the given person's name as base.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
* in the email address. Defaults to `false`.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
- * @param legacyOptions The options to use. Defaults to `{}`.
+ * @param legacyOptions The options to use.
* @param legacyOptions.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included
* in the email address. Defaults to `false`.
*
@@ -477,7 +477,7 @@ export class InternetModule extends ModuleBase {
* This will always return a plain ASCII string.
* Some basic stripping of accents and transliteration of characters will be done.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
*
@@ -537,7 +537,7 @@ export class InternetModule extends ModuleBase {
* This will always return a plain ASCII string.
* Some basic stripping of accents and transliteration of characters will be done.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
@@ -661,7 +661,7 @@ export class InternetModule extends ModuleBase {
* If the input names include Unicode characters, the resulting display name will contain Unicode characters.
* It will not contain spaces.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
*
@@ -721,7 +721,7 @@ export class InternetModule extends ModuleBase {
* If the input names include Unicode characters, the resulting display name will contain Unicode characters.
* It will not contain spaces.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
@@ -1043,7 +1043,7 @@ export class InternetModule extends ModuleBase {
* Based on
* http://stackoverflow.com/questions/43044/algorithm-to-randomly-generate-an-aesthetically-pleasing-color-palette
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.redBase The optional base red in range between `0` and `255`. Defaults to `0`.
* @param options.greenBase The optional base green in range between `0` and `255`. Defaults to `0`.
* @param options.blueBase The optional base blue in range between `0` and `255`. Defaults to `0`.
@@ -1099,7 +1099,7 @@ export class InternetModule extends ModuleBase {
* Based on
* http://stackoverflow.com/questions/43044/algorithm-to-randomly-generate-an-aesthetically-pleasing-color-palette
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.redBase The optional base red in range between `0` and `255`. Defaults to `0`.
* @param options.greenBase The optional base green in range between `0` and `255`. Defaults to `0`.
* @param options.blueBase The optional base blue in range between `0` and `255`. Defaults to `0`.
@@ -1202,7 +1202,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates a random mac address.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param separator The optional separator to use. Can be either `':'`, `'-'` or `''`. Defaults to `':'`.
*
* @example
@@ -1232,7 +1232,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates a random mac address.
*
- * @param options The optional separator or an options object. Defaults to `{}`.
+ * @param options The optional separator or an options object.
* @param separator The optional separator to use. Can be either `':'`, `'-'` or `''`. Defaults to `':'`.
*
* @example
@@ -1292,7 +1292,7 @@ export class InternetModule extends ModuleBase {
* Generates a random password-like string. Do not use this method for generating actual passwords for users.
* Since the source of the randomness is not cryptographically secure, neither is this generator.
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.length The length of the password to generate. Defaults to `15`.
* @param options.memorable Whether the generated password should be memorable. Defaults to `false`.
* @param options.pattern The pattern that all chars should match.
@@ -1364,7 +1364,7 @@ export class InternetModule extends ModuleBase {
/**
* Generates a random password.
*
- * @param options The length of the password or an options object. Defaults to `{}`.
+ * @param options The length of the password or an options object.
* @param options.length The length of the password to generate. Defaults to `15`.
* @param options.memorable Whether the generated password should be memorable. Defaults to `false`.
* @param options.pattern The pattern that all chars should match.