time-to-botec/squiggle/node_modules/@stdlib/assert/is-email-address/README.md

isEmail

Test if a value is an email address.

Usage

var isEmail = require( '@stdlib/assert/is-email-address' );

isEmail( value )

Tests if a value is an email address.

var bool = isEmail( 'beep@boop.com' );
// returns true

Notes

• Validation is not rigorous, nor should it be. 9 RFCs relate to email addresses, and accounting for all of them is a fool's errand. This module performs the simplest validation; i.e., requiring at least one @ symbol.
• For rigorous validation, send a confirmation email. If the email bounces, consider the email invalid.

Examples

var isEmail = require( '@stdlib/assert/is-email-address' );

var bool;

bool = isEmail( 'beep@boop.com' );
// returns true

bool = isEmail( 'beep' );
// returns false

bool = isEmail( 'beep.com' );
// returns false

bool = isEmail( null );
// returns false

---

CLI

Usage

Usage: is-email-address [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ is-email-address beep@boop.com
true

To use as a standard stream,

$ echo -n 'beep@boop.com' | is-email
true