string-similarity
Advanced tools
Package description
The string-similarity npm package provides functions to find the similarity between strings and to find the best match among a set of strings compared to a target string. It uses various algorithms to calculate a similarity score and can be used in applications such as fuzzy matching, search optimizations, and data deduplication.
Comparing two strings for similarity
This feature allows you to compare two strings and get a similarity score between 0 and 1, where 1 means the strings are identical.
const stringSimilarity = require('string-similarity');
const similarity = stringSimilarity.compareTwoStrings('string1', 'string2');Finding the best match in an array of strings
This feature allows you to compare a target string against an array of strings and find the one that is most similar to the target. It returns an object with the best match and ratings for all strings.
const stringSimilarity = require('string-similarity');
const matches = stringSimilarity.findBestMatch('string', ['string1', 'string2', 'string3']);The levenshtein package provides a way to calculate the Levenshtein distance between two strings, which is a measure of the difference between two sequences. It is more focused on edit distance rather than similarity score.
Fuzzyset.js is a fuzzy string set for JavaScript. It uses Levenshtein distance to compute the difference between strings and is useful for making fuzzy string matching more efficient by using a set data structure.
Natural is a general natural language facility for Node.js. It includes a variety of string comparison algorithms, including Jaro-Winkler and Levenshtein distance, and provides more comprehensive natural language processing features beyond string comparison.
Readme
Finds degree of similarity between two strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.
Install using:
npm install string-similarity --save
In your code:
var stringSimilarity = require('string-similarity');
var similarity = stringSimilarity.compareTwoStrings('healed', 'sealed');
var matches = stringSimilarity.findBestMatch('healed', ['edward', 'sealed', 'theatre']);
Requiring the module gives an object with two methods:
Returns a fraction between 0 and 1, which indicates the degree of similarity between the two strings. 0 indicates completely different strings, 1 indicates identical strings. The comparison is case-insensitive.
Order does not make a difference.
(number): A fraction from 0 to 1, both inclusive. Higher number indicates more similarity.
stringSimilarity.compareTwoStrings('healed', 'sealed');
// → 0.8
stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.',
'For sale: table in very good condition, olive green in colour.');
// → 0.7073170731707317
stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.',
'For sale: green Subaru Impreza, 210,000 miles');
// → 0.3013698630136986
stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.',
'Wanted: mountain bike with at least 21 gears.');
// → 0.11267605633802817
Compares mainString against each string in targetStrings.
(Object): An object with a ratings property, which gives a similarity rating for each target string, and a bestMatch property, which specifies which target string was most similar to the main string.
stringSimilarity.findBestMatch('Olive-green table for sale, in extremely good condition.', [
'For sale: green Subaru Impreza, 210,000 miles',
'For sale: table in very good condition, olive green in colour.',
'Wanted: mountain bike with at least 21 gears.'
]);
// →
{ ratings:
[ { target: 'For sale: green Subaru Impreza, 210,000 miles',
rating: 0.3013698630136986 },
{ target: 'For sale: table in very good condition, olive green in colour.',
rating: 0.7073170731707317 },
{ target: 'Wanted: mountain bike with at least 21 gears.',
rating: 0.11267605633802817 } ],
bestMatch:
{ target: 'For sale: table in very good condition, olive green in colour.',
rating: 0.7073170731707317 } }
##Build Status
FAQs
Finds degree of similarity between strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.
The npm package string-similarity receives a total of 889,300 weekly downloads. As such, string-similarity popularity was classified as popular.
We found that string-similarity demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.