# @types/fuzzy-search

> TypeScript definitions for fuzzy-search

Latest version **2.1.5** (published 2023-11-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/fuzzy-search
pnpm add @types/fuzzy-search
yarn add @types/fuzzy-search
bun add @types/fuzzy-search
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.5 |
| Published | 2023-11-23 |
| First published | 2018-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51465 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/fuzzy-search
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fuzzy-search
- npm.io page: https://npm.io/package/@types/fuzzy-search

## Recent versions

- 2.1.5 (latest) — 2023-11-23
- 2.1.2 (ts3.8) — 2021-12-23
- 2.1.1 (ts3.6) — 2021-07-08
- 2.1.0 (ts2.8) — 2018-12-03
- 2.1.4 — 2023-11-07
- 2.1.3 — 2023-10-18

## README

# Installation
> `npm install --save @types/fuzzy-search`

# Summary
This package contains type definitions for fuzzy-search (https://github.com/wouter2203/fuzzy-search#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fuzzy-search.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fuzzy-search/index.d.ts)
````ts
declare class FuzzySearch<T extends object | string> {
    haystack: T[];
    keys: string[];
    options: Required<FuzzySearch.Options>;

    static isMatch(item: string, query: string, caseSensitive: boolean): number;

    constructor(haystack: readonly T[], keys?: readonly string[], options?: FuzzySearch.Options);
    search(needle?: string): T[];
}

declare namespace FuzzySearch {
    interface Options {
        readonly caseSensitive?: boolean | undefined;
        readonly sort?: boolean | undefined;
    }
}

export = FuzzySearch;

````

### Additional Details
 * Last updated: Thu, 23 Nov 2023 15:35:42 GMT
 * Dependencies: none

# Credits
These definitions were written by [BendingBender](https://github.com/BendingBender).

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