Nanotechnology Promises Much

    @stdlib/assert-is-email-address
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.8 • Public • Published

    isEmail

    NPM version Build Status Coverage Status

    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( '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

    Installation

    To use the module as a general utility, install the module globally

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

    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

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    72

    Version

    0.0.8

    License

    Apache-2.0

    Unpacked Size

    39.7 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser