Migrate doctest for ValidateEmail.js

Author: defaude

String/ValidateEmail.js

@@ -1,22 +1,6 @@
-/*
-  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
-*/
+/**
+ * Returns whether the given string is a valid email address or not.
+ */
 const validateEmail = (str) => {
   if (str === '' || str === null) {
     throw new TypeError('Email Address String Null or Empty.')

String/test/ValidateEmail.test.js

@@ -19,5 +19,6 @@ describe('Validation of an Email Address', () => {
 
   it('expects to throw a type error', () => {
     expect(() => { validateEmail('') }).toThrow('Email Address String Null or Empty.')
+    expect(() => { validateEmail(null) }).toThrow('Email Address String Null or Empty.')
   })
 })