Fast Soundex implementation
Clone or download
Latest commit d72e785 Aug 30, 2018

readme.md

soundex-code Build Status Coverage Status

Soundex phonetic algorithm.

Soundex is one of the earlier phonetics algorithms, specifically designed for surnames, inspiring others such as metaphone.

Depending on your goals, additionally use a stemmer (such as stemmer).

API

Install:

npm install soundex-code

Use:

var soundex = require('soundex-code')

soundex('phonetics') // => 'P532'
soundex('Ashcraft') // => 'A261'
soundex('Lissajous') // => 'L222'
soundex('Smith') === soundex('Schmit') // => true

soundex('Ashcraftersson', 6) // => 'A26136'
soundex('A', 6) // => 'A000'

CLI

Install:

npm install -g soundex-code

Use:

Usage: soundex-code [options] <words...>

  Soundex phonetic algorithm.

Options:

  -h, --help           output usage information
  -v, --version        output version number

Usage:

# output phonetics
$ soundex-code phonetics unicorn
P532 U526

# output phonetics from stdin
$ echo "phonetics banana" | soundex-code
P532 B550

Related

License

MIT © Titus Wormer