skyra-project / jaro-winkler

A string similarity utility that uses the Jaro-Winkler algorithm

@skyra/jaro-winkler

A string similarity utility that uses the Jaro-Winkler algorithm

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 With	QR	Address
Patreon		Click Here
PayPal		Click Here
BitCoin		3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum		0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin		MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Skyra Project!

jaro-winkler's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/configure-pages action to v4
• chore(deps): update actions/deploy-pages action to v3
• chore(deps): update actions/setup-node action to v4
• chore(deps): update actions/upload-pages-artifact action to v2
• chore(deps): update crazy-max/ghaction-github-labeler action to v5
• chore(deps): update dependency ansi-regex to v6
• chore(deps): update github/codeql-action action to v3

Detected dependencies

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v3
• github/codeql-action v2
• github/codeql-action v2

.github/workflows/continuous-delivery.yml

• actions/checkout v3
• actions/setup-node v3

.github/workflows/continuous-integration.yml

• actions/checkout v3
• actions/setup-node v3
• actions/checkout v3
• actions/setup-node v3
• actions/checkout v3
• actions/setup-node v3
• codecov/codecov-action v3

.github/workflows/labelsync.yml

• actions/checkout v3
• crazy-max/ghaction-github-labeler v4

.github/workflows/static-documentation.yml

• actions/checkout v3
• actions/configure-pages v3
• actions/setup-node v2
• actions/upload-pages-artifact v1
• actions/deploy-pages v2

npm

package.json

• @commitlint/cli ^18.4.3
• @commitlint/config-conventional ^18.4.3
• @favware/cliff-jumper ^2.2.3
• @sapphire/eslint-config ^5.0.3
• @sapphire/prettier-config ^2.0.0
• @sapphire/ts-config ^5.0.0
• @types/node ^20.10.4
• @typescript-eslint/eslint-plugin ^6.14.0
• @typescript-eslint/parser ^6.14.0
• @vitest/coverage-v8 ^1.0.4
• cz-conventional-changelog ^3.3.0
• eslint ^8.55.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-prettier ^5.0.1
• lint-staged ^15.2.0
• prettier ^3.1.1
• rimraf ^5.0.5
• standard-version ^9.5.0
• ts-jest ^29.1.1
• tsup ^8.0.1
• typedoc ^0.25.4
• typescript ^5.3.3
• vitest ^1.0.4
• ansi-regex ^5.0.1
• minimist ^1.2.8
• yarn 4.0.2

---

• Check this box to trigger a request for Renovate to run again on this repository