Update examples with correct param name for emailAddress (#150)

devmehq · Sep 27, 2023 · 4ed0b72 · 4ed0b72
1 parent fc9dd1f
commit 4ed0b72
Showing 1 changed file with 2 additions and 2 deletions.
diff --git 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: '[email protected]', verifyMx: true, verifySmtp: true, timeout: 3000 });
+const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: '[email protected]', 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: '[email protected]', verifyMx: true, verifySmtp: true, timeout: 3000 });
+const { validFormat, validSmtp, validMx } = await verifyEmail({ emailAddress: '[email protected]', verifyMx: true, verifySmtp: true, timeout: 3000 });
 // validFormat: true
 // validMx: false
 // validSmtp: null