Merge pull request #532 from Khez/string-validate-email

#142 #461 Adding Doctests to String/ValidateEmail.js

Author: marsonya

String/ValidateEmail.js

@@ -1,11 +1,22 @@
 /*
-  function that takes a string input and return either it is true of false
-  a valid email address
-  e.g.: [email protected] -> true
-  e.g.: [email protected] -> true
-  e.g.: mahfoudh.arous.com ->false
+  Function that takes a string input and return either true or false
+  If it is a valid email address
 */
 
+/*
+*  Doctests
+*
+* > validateEmail('[email protected]')
+*  true
+* > validateEmail('[email protected]')
+*  true
+* > validateEmail('mahfoudh.arous.com')
+*  false
+* > validateEmail('')
+*  ! TypeError
+* > validateEmail(null)
+*  ! TypeError
+*/
 const validateEmail = (str) => {
   if (str === '' || str === null) {
     throw new TypeError('Email Address String Null or Empty.')