npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@acusti/matchmaking

v0.7.0

Published

Intuitive approximate string matching (i.e. fuzzy searches)

Downloads

711

Readme

@acusti/matchmaking

latest version maintenance status bundle size downloads per month

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 = {
    excludeMismatches?: boolean;
    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]).

The excludeMismatches option for sortByBestMatch allows that function to also filter the results to only include (partial) matches, where a match include fuzzy matches that are strong enough to qualify as a partial match. For example, considering a list of all states in alphabetical order, searching for the text "ma" with excludeMismatches: true returns:

[
    'Maine', // exact match
    'Maryland', // exact match
    'Massachusetts', // exact match
    'Kansas', // partial match
    'Hawaii', // partial match
    'Michigan', // partial match (further distance on 2nd letter)
    'Minnesota', // partial match (further distance on 2nd letter)
    'Mississippi', // partial match (further distance on 2nd letter)
    'Missouri', // partial match (further distance on 2nd letter)
    'Alabama', // end-of-text exact match
    'Oklahoma', // end-of-text exact match
    'Nebraska', // short distance from match
    'Nevada', // short distance from match
    'New Hampshire', // short distance from match
    'New Jersey', // short distance from match
    'New Mexico', // short distance from match
    'New York', // short distance from match
]