double-metaphone
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- CLI
- Types
- Compatibility
- Related
- Contribute
- Security
- License
What is this?
This package exposes a phonetic algorithm. That means it gets a certain string (typically an English word), and turns it into codes, which can then be compared to other codes (of other words), to check if they are (likely) pronounced the same.
When should I use this?
You’re probably dealing with natural language, and know you need this, if you’re here!
Depending on your goals, you likely want to additionally use a stemmer (such as
stemmer
).
Install
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install double-metaphone
In Deno with esm.sh
:
import {doubleMetaphone} from 'https://esm.sh/double-metaphone@2'
In browsers with esm.sh
:
<script type="module">
import {doubleMetaphone} from 'https://esm.sh/double-metaphone@2?bundle'
</script>
Use
import {doubleMetaphone} from 'double-metaphone'
doubleMetaphone('michael') // => ['MKL', 'MXL']
doubleMetaphone('crevalle') // => ['KRFL', 'KRF']
doubleMetaphone('Filipowitz') // => ['FLPTS', 'FLPFX']
doubleMetaphone('Xavier') // => ['SF', 'SFR']
doubleMetaphone('delicious') // => ['TLSS', 'TLXS']
doubleMetaphone('acceptingness') // => ['AKSPTNNS', 'AKSPTNKNS']
doubleMetaphone('allegrettos') // => ['ALKRTS', 'AKRTS']
With stemmer
:
import {doubleMetaphone} from 'double-metaphone'
import {stemmer} from 'stemmer'
doubleMetaphone(stemmer('acceptingness')) // => ['AKSPTNK', 'AKSPTNK']
doubleMetaphone(stemmer('allegrettos')) // => ['ALKRT', 'AKRT']
API
This package exports the identifier doubleMetaphone
.
There is no default export.
doubleMetaphone(value)
Get the double metaphone codes from a given value.
value
Value to use (string
, required).
Returns
Double metaphone codes for value
([string, string]
).
CLI
Usage: double-metaphone [options] <words...>
Double Metaphone algorithm
Options:
-h, --help output usage information
-v, --version output version number
Usage:
# output phonetics
$ double-metaphone michael
# MKL MXL
# output phonetics from stdin
$ echo 'Xavier' | double-metaphone
# SF SFR
# with stemmer
$ echo 'acceptingness' | stemmer | double-metaphone
# AKSPTNK AKSPTNK
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.
Related
-
metaphone
— metaphone algorithm -
soundex-code
— soundex algorithm -
stemmer
— porter stemmer algorithm -
dice-coefficient
— sørensen–dice coefficient -
levenshtein-edit-distance
— levenshtein edit distance -
syllable
— syllable count of English words
Contribute
Yes please! See How to Contribute to Open Source.
Security
This package is safe.