Skip to content

Commit

Permalink
fix: update doc for exampleEmail() method to match args
Browse files Browse the repository at this point in the history
  • Loading branch information
harsohailB committed Apr 7, 2022
1 parent 6c1556f commit 853a3ee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/internet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ export class Internet {
*
* @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 optional options to use. If not specified, configuration options will not be applied.
* @param options.allowSpecialCharacters The optional allow special characters flag which will include characters such
* as .!#$%&'*+-/=?^_`{|}~ in the email
* @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`.
* @param options.allowSpecialCharacters Whether special characters such as `.!#$%&'*+-/=?^_`{|}~` should be included
* in the email address. Defaults to `false`.
*
* @example
* faker.internet.exampleEmail() // '[email protected]'
* faker.internet.exampleEmail('Jeanne', 'Doe') // '[email protected]'
* faker.internet.email('Jeanne', 'Doe', 'example.fakerjs.dev', { allowSpecialCharacters: true }) // 'Jeanne%[email protected]'
* faker.internet.email('Jeanne', 'Doe', { allowSpecialCharacters: true }) // 'Jeanne%[email protected]'
*/
exampleEmail(
firstName?: string,
Expand Down

0 comments on commit 853a3ee

Please sign in to comment.