levenshtein-edit-distance

levenshtein-edit-distance

Levenshtein edit distance (by Vladimir Levenshtein). No cruft. Real fast.

Install

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

npm:

npm install levenshtein-edit-distance

API

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

import {levenshteinEditDistance} from 'levenshtein-edit-distance'

levenshteinEditDistance('levenshtein', 'levenshtein') // => 0
levenshteinEditDistance('sitting', 'kitten') // => 3
levenshteinEditDistance('gumbo', 'gambol') // => 2
levenshteinEditDistance('saturday', 'sunday') // => 3

// Case sensitive!
levenshteinEditDistance('DwAyNE', 'DUANE') !== levenshtein('dwayne', 'DuAnE') // => true

// Insensitive
levenshteinEditDistance('DwAyNE', 'DUANE', true) === levenshtein('dwayne', 'DuAnE', true) // => true

// Order insensitive
levenshteinEditDistance('aarrgh', 'aargh') === levenshtein('aargh', 'aarrgh') // => true

CLI

Usage: levenshtein-edit-distance [options] word word

Levenshtein edit distance. No cruft. Real fast.

Options:

  -h, --help           output usage information
  -v, --version        output version number
  -i, --insensitive    ignore casing

Usage:

# output distance
$ levenshtein-edit-distance sitting kitten
# 3

# output distance from stdin
$ echo "saturday,sunday" | levenshtein-edit-distance
# 3

Related

• levenshtein.c — C API
• levenshtein — C CLI
• levenshtein-rs — Rust API
• stemmer — Porter stemming algorithm
• lancaster-stemmer — Lancaster stemming algorithm
• double-metaphone — Double Metaphone implementation
• soundex-code — Fast Soundex implementation
• dice-coefficient — Sørensen–Dice coefficient
• syllable — Syllable count in an English word

License

MIT © Titus Wormer