validate.io-email-address
v1.0.0
Published
Validates if a value is an email address.
Downloads
16
Maintainers
Readme
Email Address
Validates if a value is an email address.
Installation
$ npm install validate.io-email-address
For use in the browser, use browserify.
Usage
var isValid = require( 'validate.io-email-address' );
isValid( value )
Validates if a value
is an email address.
var bool = isValid( '[email protected]' );
// 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 isValid = require( 'validate.io-email-address' );
console.log( isValid( '[email protected]') );
// returns true
console.log( isValid( 'beep' ) );
// returns false
console.log( isValid( 'beep.com' ) );
// returns false
console.log( isValid( null ) );
// returns false
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. Athan Reines.