# fast-string-similarity

> Native node module for string similarity

Latest version **0.0.1** (published 2023-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install fast-string-similarity
pnpm add fast-string-similarity
yarn add fast-string-similarity
bun add fast-string-similarity
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-10-10 |
| First published | 2023-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 70.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Kyle Smith |
| Maintainers | kylesmiff |
| Keywords | string compare, string similarity |

## Links

- npm: https://www.npmjs.com/package/fast-string-similarity
- Repository: https://github.com/smith-kyle/fast-string-similarity
- Homepage: https://github.com/smith-kyle/fast-string-similarity#readme
- Issues: https://github.com/smith-kyle/fast-string-similarity/issues
- npm.io page: https://npm.io/package/fast-string-similarity

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.18.0
- [bindings](https://npm.io/package/bindings.md) ^1.5.0

## 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

- 0.0.1 (latest) — 2023-10-10

## README

# Fast String Similarity

3x faster that JS implementation.

## Building

To compile the extension for the first time, run

```
$ npm i
$ npm run configure
$ npm run build
```

All subsequent builds only need `npm run build`

You can confirm everything built correctly by [running the test suite](#to-run-tests).

### Working With the Extension Locally

After building:

```node
$ node
> var fsc = require('fast-string-similarity')
undefined
> fsc.computeStringSimilarity("the quick brown fox", "the quick not brown fox")
0.8484848484848485
```

### To run tests:

```
$ npm test
```

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