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

dice-string-similarity

v1.0.0

Published

Finds degree of similarity between strings, based on Dice's Coefficient.

Downloads

334

Readme

String Similarity

A simple and efficient JavaScript utility for comparing string similarity using bigram comparison/Dice's Coefficient. This utility provides functions to compare two strings for their similarity and to find the best match for a given string from an array of strings. This project is a continuation/enhancement of string-similarity originally developed by aceakash.

Features

  • Compare Two Strings: Calculate the similarity score between two strings based on bigram comparison, ranging from 0 (completely different) to 1 (identical).
  • Find Best Match: Find the best matching string from an array of strings for a given main string, based on their similarity scores.

Installation

To use the String Similarity in your project, simply copy the provided code into your JavaScript file or module.

Usage

Comparing Two Strings

To compare the similarity between two strings, use the compare function:

const { compare } = require('dice-string-similarity');

const similarityScore = compare('string1', 'string2');
console.log(similarityScore); // Outputs the similarity score between 0 and 1

Finding the Best Match

To find the best match for a string from an array of target strings, use the findBestMatch function:

const { findBestMatch } = require('dice-string-similarity');

const mainString = 'main string to compare';
const targetStrings = ['target string 1', 'target string 2', 'target string 3'];
const bestMatch = findBestMatch(mainString, targetStrings);

console.log(bestMatch); // Outputs the best match object containing `ratings`, `bestMatch`, and `bestMatchIndex`

API Reference

compare(first, second)

  • Parameters
    • first (string): The first string to compare.
    • second (string): The second string to compare.
  • Returns
    • A number: The similarity score between the two strings, ranging from 0 to 1.

findBestMatch(mainString, targetStrings)

  • Parameters
    • mainString (string): The main string to compare against.
    • targetStrings (Array): An array of strings to compare the main string with.
  • Returns
    • An object containing:
      • ratings: An array of objects, each containing a target string and its rating.
      • bestMatch: The object from ratings with the highest rating.
      • bestMatchIndex: The index of bestMatch in the ratings array.

Contributing

Contributions to the String Similarity are welcome. Please ensure to follow the coding standards and submit your pull requests for review.

License

This project is open-source and available under the MIT License.