@stdlib/assert-is-email-address

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isEmail

Test if a value is an email address.

Installation

npm install @stdlib/assert-is-email-address

Usage

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

isEmail( value )

Tests if a value is an email address.

var bool = isEmail( '[e-mail]' );
// 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( '[e-mail]' );
// returns true

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

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

bool = isEmail( null );
// returns false

See Also

• @stdlib/assert-is-email-address-cli: CLI package for use as a command-line utility.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.