Skip to content

savant-realms/fizzmatch

Repository files navigation

FizzMatch

FizzMatch: A TypeScript package for fuzzy string search, implemented from scratch.

Overview

FizzMatch is a lightweight TypeScript module for fuzzy string search, implemented from scratch using Levenshtein distance. Perfect for auto-complete, typo-tolerant lookup, and search-as-you-type features.

Installation

npm install fizzmatch

Usage

import { search, topMatch } from "fizzmatch"; const items = ["apple", "banana", "orange"]; console.log(search("appl", items)); // [ { item: 'apple', distance: 1 }, … ] console.log(topMatch("banan", items)); // { item: 'banana', distance: 1 } 

Building Locally

npm install npm run build

Links

GitHub Repo: https://github.com/savant-realms/fizzmatch

NPM package: https://www.npmjs.com/package/@savant-realms/fizzmatch

About

FizzMatch: A Native Fuzzy Search NPM Package in TypeScript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors