time-to-botec/squiggle/node_modules/@stdlib/assert/is-alphanumeric/README.md

isAlphaNumeric

Test whether a string contains only alphanumeric characters.

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

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