mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
65 lines
2.1 KiB
TypeScript
65 lines
2.1 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
import { levenshteinDistance } from "./levenshtein_distance.ts";
|
|
|
|
/** Options for {@linkcode compareSimilarity}. */
|
|
export interface CompareSimilarityOptions {
|
|
/**
|
|
* Whether the distance should include case.
|
|
*
|
|
* @default {false}
|
|
*/
|
|
caseSensitive?: boolean;
|
|
/**
|
|
* A custom comparison function to use for comparing strings.
|
|
*
|
|
* @param a The first string for comparison.
|
|
* @param b The second string for comparison.
|
|
* @returns The distance between the two strings.
|
|
* @default {levenshteinDistance}
|
|
*/
|
|
compareFn?: (a: string, b: string) => number;
|
|
}
|
|
|
|
/**
|
|
* Takes a string and generates a comparator function to determine which of two
|
|
* strings is more similar to the given one.
|
|
*
|
|
* By default, calculates the distance between words using the
|
|
* {@link https://en.wikipedia.org/wiki/Levenshtein_distance | Levenshtein distance}.
|
|
*
|
|
* @param givenWord The string to measure distance against.
|
|
* @param options Options for the sort.
|
|
* @returns The difference in distance. This will be a negative number if `a`
|
|
* is more similar to `givenWord` than `b`, a positive number if `b` is more
|
|
* similar, or `0` if they are equally similar.
|
|
*
|
|
* @example Usage
|
|
*
|
|
* Most-similar words will be at the start of the array.
|
|
*
|
|
* ```ts
|
|
* import { compareSimilarity } from "@std/text/compare-similarity";
|
|
* import { assertEquals } from "@std/assert";
|
|
*
|
|
* const words = ["hi", "hello", "help"];
|
|
* const sortedWords = words.toSorted(compareSimilarity("hep"));
|
|
*
|
|
* assertEquals(sortedWords, ["help", "hi", "hello"]);
|
|
* ```
|
|
*/
|
|
export function compareSimilarity(
|
|
givenWord: string,
|
|
options?: CompareSimilarityOptions,
|
|
): (a: string, b: string) => number {
|
|
const { compareFn = levenshteinDistance } = { ...options };
|
|
if (options?.caseSensitive) {
|
|
return (a: string, b: string) =>
|
|
compareFn(givenWord, a) - compareFn(givenWord, b);
|
|
}
|
|
givenWord = givenWord.toLowerCase();
|
|
return (a: string, b: string) =>
|
|
compareFn(givenWord, a.toLowerCase()) -
|
|
compareFn(givenWord, b.toLowerCase());
|
|
}
|