@types/js-levenshtein

What is @types/js-levenshtein?

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.

What are @types/js-levenshtein's main functionalities?

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: 3

Other packages similar to @types/js-levenshtein

fast-levenshtein

The 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

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

Installation

npm install --save @types/js-levenshtein

Summary

This package contains type definitions for js-levenshtein (https://github.com/gustf/js-levenshtein).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-levenshtein.

index.d.ts

/**
 * Calculates Levenshtein distance between two strings
 */
declare function levenshtein(compareFrom: string, compareTo: string): number;

export = levenshtein;

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Pyry Rouvila.