time-to-botec/js/node_modules/@stdlib/assert/is-alphagram/README.md

isAlphagram

Test if a value is an alphagram.

Usage

var isAlphagram = require( '@stdlib/assert/is-alphagram' );

isAlphagram( value )

Tests if a value is an alphagram (i.e., a sequence of characters arranged in alphabetical order).

var value = 'beep';

var bool = isAlphagram( value );
// returns true

Notes

• The function first checks that an input value is a string before validating that the value is an alphagram. For non-string values, the function returns false.

Examples

var isAlphagram = require( '@stdlib/assert/is-alphagram' );

var out = isAlphagram( 'beep' );
// returns true

out = isAlphagram( new String( 'beep' ) );
// returns true

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

out = isAlphagram( 'zba' );
// returns false

out = isAlphagram( 123 );
// returns false

---

CLI

Usage

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

Options:

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

Examples

$ is-alphagram beep
true

To use as a standard stream,

$ echo -n 'hello' | is-alphagram
false