> For the complete documentation index, see [llms.txt](https://bryan-guner.gitbook.io/my-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bryan-guner.gitbook.io/my-docs/redux/repos/examples/real-world/node_modules/damerau-levenshtein.md).

# damerau-levenshtein

[![NPM](https://nodei.co/npm/damerau-levenshtein.png?downloads=true\&downloadRank=true\&stars=true)](https://nodei.co/npm/damerau-levenshtein/)

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

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

### Install

```
npm install damerau-levenshtein
```

### Use with ES6 modules

```js
import * as levenshtien from 'damerau-levenshtein';

const lev = levenshtien('hello world', 'Hello World!');
// { steps: 4, relative: 0.3076923076923077, similarity: 0.6923076923076923 }
```

Please see [tests](https://github.com/bgoonz/Learning-Redux/blob/master/repos/examples/real-world/node_modules/damerau-levenshtein/test/test.js) for more insights.

### Use with TypeScript

```ts
import * as levenshtien from 'damerau-levenshtein';

interface LevenshteinResponse {
  steps: number;
  relative: number;
  similarity: number;
}

const lev: LevenshteinResponse = levenshtien('hello world', 'Hello World!');

console.log(lev.steps);
// 2
console.log(lev.foo);
// TypeScript Error: Property 'foo' does not exist on type 'LevenshteinResponse'.
```