Skip to content

Commit 853a3ee

Browse files
committed
fix: update doc for exampleEmail() method to match args
1 parent 6c1556f commit 853a3ee

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/internet.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ export class Internet {
7474
*
7575
* @param firstName The optional first name to use. If not specified, a random one will be chosen.
7676
* @param lastName The optional last name to use. If not specified, a random one will be chosen.
77-
* @param options The optional options to use. If not specified, configuration options will not be applied.
78-
* @param options.allowSpecialCharacters The optional allow special characters flag which will include characters such
79-
* as .!#$%&'*+-/=?^_`{|}~ in the email
77+
* @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`.
78+
* @param options.allowSpecialCharacters Whether special characters such as `.!#$%&'*+-/=?^_`{|}~` should be included
79+
* in the email address. Defaults to `false`.
8080
*
8181
* @example
8282
* faker.internet.exampleEmail() // '[email protected]'
8383
* faker.internet.exampleEmail('Jeanne', 'Doe') // '[email protected]'
84-
* faker.internet.email('Jeanne', 'Doe', 'example.fakerjs.dev', { allowSpecialCharacters: true }) // 'Jeanne%[email protected]'
84+
* faker.internet.email('Jeanne', 'Doe', { allowSpecialCharacters: true }) // 'Jeanne%[email protected]'
8585
*/
8686
exampleEmail(
8787
firstName?: string,

0 commit comments

Comments
 (0)