JSPM

compare-strings

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17
  • Score
    100M100P100Q53735F
  • License MIT

Finds degree of similarity between two strings, based on Dice's Coefficient and Levenshtein Distance.

Package Exports

  • compare-strings

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compare-strings) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

compare-strings

Finds degree of similarity between two strings, based on Dice's Coefficient and Levenshtein Distance.

Table of Contents

Usage

Install using:

npm install compare-strings --save

In your code:

var compareStrings = require('compare-strings');

var similarity = compareStrings('healed', 'sealed');

API

compareStrings(string1, string2)

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.

Arguments
  1. string1 (string): The first string
  2. string2 (string): The second string

Order does not make a difference.

Returns

(number): A fraction from 0 to 1, both inclusive. Higher number indicates more similarity.

Examples
stringSimilarity.compareTwoStrings('healed', 'sealed');
// → 0.8166666666666667

stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.', 
  'For sale: table in very good  condition, olive green in colour.');
// → 0.4774114774114774

stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.', 
  'For sale: green Subaru Impreza, 210,000 miles');
// → 0.27886002886002886

stringSimilarity.compareTwoStrings('Olive-green table for sale, in extremely good condition.', 
  'Wanted: mountain bike with at least 21 gears.');
// → 0.159992784992785