Anagram

Validates if a value is an anagram.

Installation

$ npm install validate.io-anagram

For use in the browser, use browserify.

Usage

var isAnagram = require( 'validate.io-anagram' );

isAnagram( str, value )

Validates if a value is an anagram.

var value = 'William Shakespeare';

var bool = isAnagram( 'I am a weakish speller', value );
// returns true

Notes

• The function does not address the presence of diacritics.
• Only alphanumeric characters are considered.
• Capitalization is ignored.
• If provided a non-string for the first argument, the function throws an Error.
• If provided a non-string for the second argument, the function returns false.

Examples

var isAnagram = require( 'validate.io-anagram' );

var bool = isAnagram( 'I am a weakish speller', 'William Shakespeare' );
console.log( bool );
// returns true

bool = isAnagram( 'bat', 'tab' );
console.log( bool );
// returns true

bool = isAnagram( 'bat', 'TAB' );
console.log( bool );
// returns true

bool = isAnagram( 'bat', 't a b' );
console.log( bool );
// returns true

bool = isAnagram( 'bat 321', 'tab 123' );
console.log( bool );
// returns true

bool = isAnagram( 'bat', 'tabba' );
console.log( bool );
// returns false

bool = isAnagram( 'bat', 5 );
console.log( bool );
// returns false

bool = isAnagram( '123', 321 );
console.log( bool );
// 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.