time-to-botec/squiggle/node_modules/@stdlib/assert/is-hex-string/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.2 KiB

isHexString

Test whether a string contains only hexadecimal digits.

Usage

var isHexString = require( '@stdlib/assert/is-hex-string' );

isHexString( value )

Tests whether a string contains only hexadecimal digits.

var bool = isHexString( '0123456789abcdefABCDEF' );
// returns true

Notes

  • For non-string values, the function returns false.
  • The function does not recognize x (as in the standard 0x prefix).

Examples

var isHexString = require( '@stdlib/assert/is-hex-string' );

var out = isHexString( '0123456789abcdefABCDEF' );
// returns true

out = isHexString( '' );
// returns false

out = isHexString( '0xffffff' );
// returns false

out = isHexString( 123 );
// returns false

CLI

Usage

Usage: is-hex-string [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ is-hex-string 0123456789abcdefABCDEF
true

To use as a standard stream,

$ echo -n '0123456789abcdefABCDEF' | is-hex-string
true