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

find-similar

v1.2.6

Published

Finds similar word(s) in a list of words

Downloads

55

Readme

find-similar

Finds similar word(s) in a list of words.

Install

npm i find-similar

Usage

This package is pure ESM, please read the esm-package.

import { findSimilar, didYouMean } from 'find-similar'

console.log(findSimilar('foos', ['bar', 'baz', 'foo']))
// => ['foo']

// Suggests similar words
console.log(didYouMean('foos', ['bar', 'baz', 'foo']))
// => 'Did you mean "foo"?'

API Reference

findSimilar(word: string, candidates: readonly string[] | string[], options?: Options): string[]

Finds similar word(s) in a list of words.

  • word: The word to find similar words for.
  • candidates: An array of words to compare against.
  • options: Options for the function (optional).
    • maxScore: Maximum levenshtein distance threshold. (default: 3)
    • criteria: The similarity threshold, a number between 0 and 1. (default: 0.5)
    • prefix: A string to prepend to the suggested word. (default: '')

Returns an array of similar words.

didYouMean(word: string, candidates: readonly string[] | string[], options?: Options): string

Suggests similar words in a list of words.

  • word: The word to find similar words for.
  • candidates: An array of words to compare against.
  • options: Options for the function (optional).
    • maxScore: Maximum levenshtein distance threshold. (default: 3)
    • criteria: The similarity threshold, a number between 0 and 1. (default: 0.5)
    • prefix: A string to prepend to the suggested word. (default: '')

Returns a string of suggested words or an empty string if no matches are found.

Options

  • maxScore: Maximum levenshtein distance threshold. (default: 3)
  • criteria: The similarity threshold, a number between 0 and 1. (default: 0.5)
  • prefix: A string to prepend to the suggested word. (default: '')

Contributing

We 💛  issues.

When committing, please conform to the semantic-release commit standards. Please install commitizen and the adapter globally, if you have not already.

npm i -g commitizen cz-conventional-changelog

Now you can use git cz or just cz instead of git commit when committing. You can also use git-cz, which is an alias for cz.

git add . && git cz

License

GitHub

A project by Stilearning © 2022-2023.