0.2.1 • Published 2 months ago
@stdlib/assert-is-alphanumeric v0.2.1
isAlphaNumeric
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 characters0-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
See Also
@stdlib/assert-is-alphanumeric-cli
: CLI package for use as a command-line utility.@stdlib/assert-is-digit-string
: test whether a string contains only numeric digits.
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.