@stdlib/assert-is-hex-string

Test whether a string contains only hexadecimal digits.


Keywords
stdlib, stdassert, assertion, assert, utilities, utility, utils, util, string, str, hex, hexadecimal, digit, is, isstring, ishex, ishexadecimal, validate, valid, isvalid, test, check, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/assert-is-hex-string@0.0.7

Documentation

isHexString

NPM version Build Status Coverage Status dependencies

Test whether a string contains only hexadecimal digits.

Installation

npm install @stdlib/assert-is-hex-string

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

Installation

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

npm install -g @stdlib/assert-is-hex-string

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

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-2021. The Stdlib Authors.