Nullifying Precipitation Machine

    @stdlib/assert-is-anagram
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isAnagram

    NPM version Build Status Coverage Status dependencies

    Test if a value is an anagram.

    Installation

    npm install @stdlib/assert-is-anagram

    Usage

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

    isAnagram( str, value )

    Tests if a value is an anagram.

    var str = 'I am a weakish speller';
    var value = 'William Shakespeare';
    
    var bool = isAnagram( str, 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( '@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

    CLI

    Installation

    To use the module as a general utility, install the module globally

    npm install -g @stdlib/assert-is-anagram

    Usage

    Usage: is-anagram [options] [<string>] --str=<string>
    
    Options:
    
      -h,    --help                Print this message.
      -V,    --version             Print the package version.
             --str string          Comparison string.
    

    Examples

    $ is-anagram baz --str=zab
    true

    To use as a standard stream,

    $ echo -n 'tab\nbaz' | is-anagram --str=bat
    true
    false

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-anagram

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    40

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    40.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser