1.1.1 • Published 21 days ago

@skyra/jaro-winkler v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
21 days ago

@skyra/jaro-winkler

A string similarity utility that uses the Jaro-Winkler algorithm

GitHub codecov npm

Description

A string similarity function using the Jaro-Winkler distance metric. Returns a number between 0 and 1. A 0 being no similarity and a 1 being an exact match.

Read more about it on Wikipedia.

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @skyra/jaro-winkler

Usage

const { jaroWinkler } = require('@skyra/jaro-winkler');
import { jaroWinkler } from '@skyra/jaro-winkler';

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate WithQRAddress
PatreonPatreonImageClick Here
PayPalPayPalImageClick Here
BitCoinBitcoinImage3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
EthereumEthereumImage0xcB5EDB76Bc9E389514F905D9680589004C00190c
LitecoinLitecoinImageMNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!