From 4ed0b72d2bc8ac4fc904b5f85e17d6340668eb52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=99=9A=20PH=E2=91=A6=20de=20Soria=E2=84=A2=E2=99=9B?= Date: Wed, 27 Sep 2023 14:46:35 +1000 Subject: [PATCH] Update examples with correct param name for `emailAddress` (#150) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a8aebc..a9f01b7 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ npm install @devmehq/email-validator-js ```typescript import { verifyEmail } from '@devmehq/email-validator-js'; -const { validFormat, validSmtp, validMx } = await verifyEmail({ mailbox: 'foo@email.com', verifyMx: true, verifySmtp: true, timeout: 3000 }); +const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: 'foo@email.com', verifyMx: true, verifySmtp: true, timeout: 3000 }); // validFormat: true // validMx: true // validSmtp: true @@ -64,7 +64,7 @@ const { validFormat, validSmtp, validMx } = await verifyEmail({ mailbox: 'foo@em When a domain does not exist or has no MX records, the domain validation will fail, and the mailbox validation will return `null` because it could not be performed: ```typescript -const { validFormat, validSmtp, validMx } = await verifyEmail({ mailbox: 'foo@bad-domain.com', verifyMx: true, verifySmtp: true, timeout: 3000 }); +const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: 'foo@bad-domain.com', verifyMx: true, verifySmtp: true, timeout: 3000 }); // validFormat: true // validMx: false // validSmtp: null