soundex-code

soundex-code

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).

Install

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

npm:

npm install soundex-code

API

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

import {soundex} from '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

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

• metaphone — Metaphone implementation
• double-metaphone — Double Metaphone implementation
• stemmer — Porter Stemmer algorithm
• dice-coefficient — Sørensen–Dice coefficient
• levenshtein-edit-distance — Levenshtein edit distance
• syllable — Syllable count in an English word

License

MIT © Titus Wormer