compare-string

A lightweight, pure JS package to calculate the degree of similarity between strings. Uses a combination of the Sørensen–Dice coefficient and Jaccard's Index. Can generally return much faster, more accurate results than other edit-distance based algorithms, such as Levenshtein.

Installation

npm i compare-string

Example Usage

const { compareString, matchArray } = require('compare-string');

console.log(compareString('please help', 'some help, please'));
//output :: 0.733173076923077

console.log(
  matchArray('catch me if you can!', [
    'try catch block',
    'nice catch bro',
    "fine, i'll catch you if i can",
  ])
);
/* output ::
{
  bestMatch: "fine, i'll catch you if i can",
  bestMatchRating: 0.5718085106382979,
  sorted: [
    [ "fine, i'll catch you if i can", 0.5718085106382979 ],
    [ 'nice catch bro', 0.4010416666666667 ],
    [ 'try catch block', 0.3304195804195804 ]
  ]
}
*/

Methods

This package has two simple methods: .matchArray() and .compareString()

compareString(string1, string2, { options })

Evaluates the degree of similarity between string1 and string2. Returns a number between 0 and 1.

matchArray(string, array, { options })

Finds the best match(es) in an array for a given string. Returns ArrayMatch

Types

options

Object: {
  strict: boolean;
}

ArrayMatch

Object: {
  bestMatch: string,
  bestMatchRating: number (between 0 and 1),
  sorted: Array [
    Array [matched string, number]
  ]
}

Contributing

See CONTRIBUTING.md and the official repository link here.