# sem1083.fuzzy

> The (not) best and most simple fuzzy find for js.

Latest version **0.0.8** (published 2020-05-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install sem1083.fuzzy
pnpm add sem1083.fuzzy
yarn add sem1083.fuzzy
bun add sem1083.fuzzy
```

## 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.8 |
| Published | 2020-05-08 |
| First published | 2020-04-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sem#1083 |
| Maintainers | sem1083 |

## Links

- npm: https://www.npmjs.com/package/sem1083.fuzzy
- npm.io page: https://npm.io/package/sem1083.fuzzy

## Recent versions

- 0.0.8 (latest) — 2020-05-08
- 0.0.7 — 2020-04-30
- 0.0.6 — 2020-04-30
- 0.0.5 — 2020-04-30
- 0.0.4 — 2020-04-15
- 0.0.3 — 2020-04-15
- 0.0.2 — 2020-04-15
- 0.0.1 — 2020-04-15

## README

# Sem1083.fuzzy

`Sem1083.fuzzy` is a node.js package used for approximate string matching.

## Installation

Use the package manager [npm](https://www.npmjs.com/get-npm) to install this package.

```bash
npm install sem1083.fuzzy
```

## Usage
`compare` -> Compare two strings. This will return a score between 0 and 1.

```js
let x = require(`sem1083.fuzzy`);

x.compare('fuzy','fuzzy')
//=> 0.8571428571428571

```
`filter` -> Compare a string with an array of strings. Will return a sorted array with the first entry being the best and the last the worst. 
```js
let x = require(`sem1083.fuzzy`);

x.filter('fuzy',['fuzzy','fuzy'])
//=> [ [Object], [Object], get: [Function] ]
//=> First object: { string: 'fuzy', score: 1 }

x.filter('fuzy',['fuzzy','fuzy']).get(0,1) //.get is slice but fancy
//=> [ [Object], get: [Function] ]

```

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