National Pizza Magistrate

    @artur_mkrtchyannnn/metaphone
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    metaphone

    Build Coverage Downloads Size

    Metaphone algorithm.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install metaphone

    API

    This package exports the following identifiers: metaphone. There is no default export.

    import {metaphone} from 'metaphone'
    
    metaphone('michael') // => 'MXL'
    metaphone('crevalle') // => 'KRFL'
    metaphone('Filipowitz') // => 'FLPWTS'
    metaphone('Xavier') // => 'SFR'
    metaphone('delicious') // => 'TLSS'
    metaphone('acceptingness') // => 'AKSPTNKNS'
    metaphone('allegrettos') // => 'ALKRTS'

    With stemmer:

    var metaphone = require('metaphone')
    var stemmer = require('stemmer')
    
    metaphone(stemmer('acceptingness')) // => 'AKSPTNK'
    metaphone(stemmer('allegrettos')) // => 'ALKRT'

    CLI

    Usage: metaphone [options] <words...>
    
    Metaphone implementation
    
    Options:
    
      -h, --help           output usage information
      -v, --version        output version number
    
    Usage:
    
    # output phonetics
    $ metaphone considerations detestable
    # KNSTRXNS TTSTBL
    
    # output phonetics from stdin
    $ echo 'hiccups vileness' | metaphone
    # HKKPS FLNS
    
    # with stemmer
    $ echo 'vileness' | stemmer | metaphone
    # FL
    

    Related

    License

    MIT © Titus Wormer

    Install

    npm i @artur_mkrtchyannnn/metaphone

    DownloadsWeekly Downloads

    2

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    15.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • artur_mkrtchyan