From 853a3ee38dd48a715ba6f103ad5f8b81a9f79f7e Mon Sep 17 00:00:00 2001 From: Harsohail Brar Date: Thu, 7 Apr 2022 09:40:27 -0600 Subject: [PATCH] fix: update doc for exampleEmail() method to match args --- src/internet.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/internet.ts b/src/internet.ts index 46d64090646..6ec5d4c3827 100644 --- a/src/internet.ts +++ b/src/internet.ts @@ -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() // 'Helmer.Graham23@example.com' * faker.internet.exampleEmail('Jeanne', 'Doe') // 'Jeanne96@example.net' - * faker.internet.email('Jeanne', 'Doe', 'example.fakerjs.dev', { allowSpecialCharacters: true }) // 'Jeanne%Doe88@example.fakerjs.dev' + * faker.internet.email('Jeanne', 'Doe', { allowSpecialCharacters: true }) // 'Jeanne%Doe88@example.fakerjs.dev' */ exampleEmail( firstName?: string,