Narrowly Preventing Mayhem

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

    0.0.8 • Public • Published

    isAlphaNumeric

    NPM version Build Status Coverage Status

    Test whether a string contains only alphanumeric characters.

    Installation

    npm install @stdlib/assert-is-alphanumeric

    Usage

    var isAlphaNumeric = require( '@stdlib/assert-is-alphanumeric' );

    isAlphaNumeric( value )

    Tests whether a string contains only alphanumeric characters.

    var bool = isAlphaNumeric( 'abc0123456789' );
    // returns true

    Notes

    • For non-string values, the function returns false.
    • Alphanumeric is defined as the characters a-zA-Z and the numeric characters 0-9.

    Examples

    var isAlphaNumeric = require( '@stdlib/assert-is-alphanumeric' );
    
    var out = isAlphaNumeric( 'abs0123456789' );
    // returns true
    
    out = isAlphaNumeric( '0xffffff' );
    // returns true
    
    out = isAlphaNumeric( '' );
    // returns false
    
    out = isAlphaNumeric( 123 );
    // returns false

    CLI

    Installation

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

    npm install -g @stdlib/assert-is-alphanumeric

    Usage

    Usage: is-alphanumeric [options] [<string>]
    
    Options:
    
      -h,    --help                Print this message.
      -V,    --version             Print the package version.
    

    Examples

    $ is-alphanumeric 01abc23456789
    true

    To use as a standard stream,

    $ echo -n '0123456789' | is-alphanumeric
    true

    See Also


    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-alphanumeric

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    43

    Version

    0.0.8

    License

    Apache-2.0

    Unpacked Size

    40.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser