# isAnagram

> Test if a value is an [anagram][anagram].


<section class="usage">

## Usage

``` javascript
var isAnagram = require( '@stdlib/assert/is-anagram' );
```


#### isAnagram( str, value )

Tests if a `value` is an [anagram][anagram].

``` javascript
var str = 'I am a weakish speller';
var value = 'William Shakespeare';

var bool = isAnagram( str, value );
// returns true
```

</section>

<!-- /.usage -->


<section class="notes">

## Notes

* The function does __not__ address the presence of [diacritics][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`.

</section>

<!-- /.notes -->


<section class="examples">

## Examples

``` javascript
var isAnagram = require( '@stdlib/assert/is-anagram' );

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

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

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

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

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

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

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

bool = isAnagram( '123', 321 );
// returns false
```

</section>

<!-- /.examples -->


<section class="links">

[anagram]: http://en.wikipedia.org/wiki/Anagram
[diacritics]: http://en.wikipedia.org/wiki/Diacritic

</section>

<!-- /.links -->
