time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (757B)


      1 
      2 {{alias}}( value )
      3     Tests if a value is an email address.
      4 
      5     Validation is not rigorous. *9* RFCs relate to email addresses, and
      6     accounting for all of them is a fool's errand. The function performs the
      7     simplest validation; i.e., requiring at least one `@` symbol.
      8 
      9     For rigorous validation, send a confirmation email. If the email bounces,
     10     consider the email invalid.
     11 
     12     Parameters
     13     ----------
     14     value: any
     15         Value to test.
     16 
     17     Returns
     18     -------
     19     bool: boolean
     20         Boolean indicating whether value is an email address.
     21 
     22     Examples
     23     --------
     24     > var bool = {{alias}}( 'beep@boop.com' )
     25     true
     26     > bool = {{alias}}( 'beep' )
     27     false
     28     > bool = {{alias}}( null )
     29     false
     30 
     31     See Also
     32     --------
     33