@acusti/matchmaking

@acusti/matchmaking

Intuitive approximate string matching (i.e. fuzzy searches). See the tests to understand its behavior and evaluate if it’s what you are looking for.

Usage

npm install @acusti/matchmaking
# or
yarn add @acusti/matchmaking

matchmaking exports two functions: getBestMatch and sortByBestMatch. Import them by name:

import { getBestMatch, sortByBestMatch } from '@acusti/matchmaking';

Both functions take the same payload:

type Payload = {
    items: Array<string>;
    text: string;
};

However, sortByBestMatch returns an array of items matching the one passed in but sorted by how close they match the passed-in text, while getBestMatch just returns the text of the single closest match found (i.e. sortByBestMatch(payload)[0]);