fast-levenshtein - Levenshtein algorithm in Javascript
A Javascript implementation of the Levenshtein algorithm with locale-specific collator support. This uses fastest-levenshtein under the hood.
Features
- Works in node.js and in the browser.
- Locale-sensitive string comparisons if needed.
- Comprehensive test suite.
Installation
$ npm install fast-levenshtein
CDN
The latest version is now also always available at https://npm-cdn.com/pkg/fast-levenshtein/
Examples
Default usage
var levenshtein = require('fast-levenshtein');
var distance = levenshtein.get('back', 'book'); // 2
var distance = levenshtein.get('我愛你', '我叫你'); // 1
Locale-sensitive string comparisons
It supports using Intl.Collator for locale-sensitive string comparisons:
var levenshtein = require('fast-levenshtein');
levenshtein.get('mikailovitch', 'Mikhaïlovitch', { useCollator: true});
// 1
Building and Testing
To build the code and run the tests:
$ npm install -g grunt-cli
$ npm install
$ npm run build
Performance
This uses fastest-levenshtein under the hood.
Contributing
If you wish to submit a pull request please update and/or create new tests for any changes you make and ensure the grunt build passes.
See CONTRIBUTING.md for details.
License
MIT - see LICENSE.md