@stdlib/assert-is-alphagram
v0.2.2
Published
Test if a value is an alphagram.
Downloads
59
Readme
isAlphagram
Test if a value is an alphagram.
Installation
npm install @stdlib/assert-is-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 astring
before validating that thevalue
is an alphagram. For non-string values, the function returnsfalse
.
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
See Also
@stdlib/assert-is-alphagram-cli
: CLI package for use as a command-line utility.@stdlib/assert-is-anagram
: test if a value is an anagram.
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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.