Skip to content

EDumdum/levenshtein-js

Repository files navigation

npm version Build Status GitHub license

levenshtein-js

Implementation of the Levenshtein algorithm used to calculate distince between strings.

Installation

Install using npm:

$ npm install --save fast-levenshtein-string

Usage

var levenshtein = require('fast-levenshtein-string');

levenshtein.compute('niche', 'chiens'); // 5

API

compute(rawWord1: String, rawWord2: String) -> Number

Check requirements.
Returns Levensthein distance between rawWord1 and rawWord2.

Required

  • rawWord1 must be not Null
  • rawWord1 must be of type String
  • rawWord2 must be not Null
  • rawWord2 must be of type String

computeWithtoutCheck(rawWord1: String, rawWord2: String) -> Number

Does NOT check requirements.
Returns Levensthein distance between rawWord1 and rawWord2.

Required

  • rawWord1 must be not Null
  • rawWord1 must be of type String
  • rawWord2 must be not Null
  • rawWord2 must be of type String

About

Implementation of the Levenshtein algorithm used to calculate distince between strings.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published