@types/levenshtein

Installation

npm install --save @types/levenshtein

Summary

This package contains type definitions for levenshtein (https://github.com/gf3/Levenshtein).

Details

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

index.d.ts

declare class Levenshtein {
    /**
     * Levenshtein string difference
     * @param m First string
     * @param n Second string
     */
    constructor(m: string, n: string);

    /**
     * Distance between strings
     */
    distance: number;

    /**
     * Distance between strings
     * Alias of distance
     */
    valueOf(): number;

    /**
     * Pretty print Levenshtein table.
     */
    inspect(): string;

    /**
     * Pretty print Levenshtein table.
     * Alias of inspect()
     */
    toString(): string;

    /**
     * Return the Levenshtein table.
     */
    getMatrix(): number[][];
}

// Required to make import as syntax work
declare namespace Levenshtein {
}

export = Levenshtein;

Additional Details

• Last updated: Tue, 07 Nov 2023 0938 GMT
• Dependencies: none

Credits

These definitions were written by Joshua DeVinney.