validate.io-alphagram

alphagram

Validates if a value is an alphagram.

Installation

$ npm install validate.io-alphagram

For use in the browser, use browserify.

Usage

var isAlphagram = require( 'validate.io-alphagram' );

isAlphagram( value )

Validates 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

Note: 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( 'validate.io-alphagram' );
 
console.log( isAlphagram( 'beep' ) );
// returns true
 
console.log( isAlphagram( new String( 'beep' ) ) );
// returns true
 
console.log( isAlphagram( '' ) );
// returns false
 
console.log( isAlphagram( 'zba' ) );
// returns false
 
console.log( isAlphagram( 123 ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.