It provides a function that takes two string arguments and returns a hash like this:

1{
2  steps: 5,       // Levenstein demerau distance
3  relative: 0.7,  // steps / length of the longer string
4  similarity: 0.3 // 1 - relative
5}

Install

1npm install damerau-levenshtein

Use with ES6 modules

1import * as levenshtein from 'damerau-levenshtein';
2
3const lev = levenshtein('hello world', 'Hello World!');
4// { steps: 4, relative: 0.3076923076923077, similarity: 0.6923076923076923 }

Please see tests for more insights.

Use with TypeScript

1import * as levenshtein from 'damerau-levenshtein';
2
3interface LevenshteinResponse {
4  steps: number;
5  relative: number;
6  similarity: number;
7}
8
9const lev: LevenshteinResponse = levenshtein('hello world', 'Hello World!');
10
11console.log(lev.steps);
12// 2
13console.log(lev.foo);
14// TypeScript Error: Property 'foo' does not exist on type 'LevenshteinResponse'.