Test whether a string contains only alphanumeric characters.
npm install @stdlib/assert-is-alphanumericAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var isAlphaNumeric = require( '@stdlib/assert-is-alphanumeric' );Tests whether a string contains only alphanumeric characters.
var bool = isAlphaNumeric( 'abc0123456789' );
// returns true- For non-string values, the function returns
false. - Alphanumeric is defined as the characters
a-zA-Zand the numeric characters0-9.
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 falseTo use the module as a general utility, install the module globally
npm install -g @stdlib/assert-is-alphanumericUsage: is-alphanumeric [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
-
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'beep\n01abc23456789' | is-alphanumeric --split /\r?\n/ # Escaped... $ echo -n $'beep\n01abc23456789' | is-alphanumeric --split /\\r?\\n/
-
The implementation ignores trailing delimiters.
$ is-alphanumeric 01abc23456789
trueTo use as a standard stream,
$ echo -n '0123456789' | is-alphanumeric
trueBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n 'beep\t01abc23456789' | is-alphanumeric --split '\t'
false
true@stdlib/assert/is-digit-string: test whether a string contains only numeric digits.
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.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.
