# string-compare

> A utility to compare strings for similarity

Latest version **1.1.2** (published 2021-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install string-compare
pnpm add string-compare
yarn add string-compare
bun add string-compare
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2021-03-30 |
| First published | 2018-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | mykeels |
| Maintainers | mykeels |
| Keywords | string, compare |

## Links

- npm: https://www.npmjs.com/package/string-compare
- Repository: https://github.com/mykeels/string-compare
- Homepage: https://github.com/mykeels/string-compare#readme
- Issues: https://github.com/mykeels/string-compare/issues
- npm.io page: https://npm.io/package/string-compare

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.13.10

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2021-03-30
- 1.1.1 — 2021-03-30
- 1.1.0 — 2021-03-30
- 1.0.1 — 2018-02-09
- 1.0.0 — 2018-01-19

## README

# String Compare

Used to compare two strings to get the degree of similarity between 0 and 1

## Installation

```bash
    npm i -s string-compare
```

or

```bash
    yarn add string-compare
```

## Usage

```js
    const { compare } = require('string-compare');

    compare('String 1', 'String 2'); // 0.8
```

or

```js
    import compare from 'string-compare';

    compare('Hello World', 'helo'); //0.4
    compare('Hello World', 'Helo'); //0.5
    compare('Hello World', 'word'); //0.4
    compare('Hello World', 'Word'); //0.5
```

---
_Source: https://npm.io/package/string-compare · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._