@types/js-levenshtein
Advanced tools
Package description
The @types/js-levenshtein package provides TypeScript type definitions for the js-levenshtein package, which is an efficient JavaScript implementation of the Levenshtein algorithm. This algorithm calculates the minimum number of single-character edits (insertions, deletions, or substitutions) required to change one word into another. The type definitions enable TypeScript developers to use js-levenshtein in their projects with type checking, ensuring that they pass the correct types of arguments to the functions and use the returned values as expected.
Calculating Levenshtein Distance
This feature allows you to calculate the Levenshtein distance between two strings, which is the minimum number of single-character edits required to change one string into the other. The code sample demonstrates how to import the levenshtein function and use it to calculate the distance between 'kitten' and 'sitting', which is 3.
import levenshtein from 'js-levenshtein';
const distance = levenshtein('kitten', 'sitting');
console.log(distance); // Output: 3The fast-levenshtein package is another JavaScript implementation of the Levenshtein distance algorithm. It claims to be the fastest JS implementation of the algorithm. Compared to js-levenshtein, fast-levenshtein might offer better performance in some scenarios, but both provide similar basic functionality of calculating the Levenshtein distance.
levenshtein-edit-distance is a package that also calculates the Levenshtein distance between two strings. It focuses on being a simple and small implementation. While js-levenshtein and fast-levenshtein might be optimized for performance, levenshtein-edit-distance offers a minimalistic approach which might be preferable for projects where bundle size is a concern.
Readme
npm install --save @types/js-levenshtein
This package contains type definitions for js-levenshtein (https://github.com/gustf/js-levenshtein).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-levenshtein.
/**
* Calculates Levenshtein distance between two strings
*/
declare function levenshtein(compareFrom: string, compareTo: string): number;
export = levenshtein;
These definitions were written by Pyry Rouvila.
FAQs
TypeScript definitions for js-levenshtein
The npm package @types/js-levenshtein receives a total of 1,646,319 weekly downloads. As such, @types/js-levenshtein popularity was classified as popular.
We found that @types/js-levenshtein demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.