Getting started

Installation

Install the library using your package manager of choice:

npm i @polgubau/fuzzy

Basic Usage

Import the library and use it with a simple list:

index.ts

import fuzzy from '@polgubau/fuzzy';
 
const list = ["volvo", "seat", "mercedes", "audi", "bmw"];
const queryText = "volv"; // The search term
const fuzzySearch = fuzzy(list);
 
// Run this whenever the search term changes
const fuzzedList = fuzzySearch(queryText);
console.log(fuzzedList);

Are you using a framework?

We have special hooks and components for you if you use React or Vue. Check the Frameworks tabs for more information.

Response Structure

This code returns a list of results along with metadata about the search.

Prop	Type	Default
`results`	`Result<T>[]`	`""`
`length`	`number`	`0`
`time`	`number`	`0`
`normalizedQuery`	`string`	`""`
`hasExactMatch`	`boolean`	`false`
`bestMatch`	`Result<T>`	`null`
`hasResults`	`boolean`	`false`

Getting started

Installation

Using CDN?

Basic Usage

Response Structure

On this page