fagan2888 / fuse

Lightweight fuzzy-search, in JavaScript

Fuse.js

Supporting Fuse.js

Through contributions, donations, and sponsorship, you allow Fuse.js to thrive. Also, you will be recognized as a beacon of support to open-source developers.

• Become a backer or sponsor on GitHub.
• Become a backer or sponsor on Patreon.
• One-time donation via PayPal.

---

Introduction

Fuse.js is a lightweight fuzzy-search, in JavaScript, with zero dependencies.

Browser Compatibility

Fuse.js supports all browsers that are ES5-compliant (IE8 and below are not supported).

Documentation

To checkout out live examples and docs, visit fusejs.io.

Installation

NPM

$ npm install --save fuse.js

Yarn

$ yarn add fuse.js

CDN

Available on CDN via jsDelivr.

Note: it takes some time for the CDNs to sync with the latest version

Deno

Available in Deno via deno.land/x

// @deno-types="https://deno.land/x/[email protected]/dist/fuse.d.ts"
import Fuse from 'https://deno.land/x/[email protected]/dist/fuse.esm.min.js';

Explanation of Different Builds

In the dist/ directory of the NPM package you will find many different builds of Fuse.js. Here's an overview of the difference between them.

Issues

This repository serves as the main issue tracker. When creating issues, it's important to follow common guidelines to make them extra clear. Here is a few links to help you achieve that:

• GitHub Guides: Mastering Issues
• Wiredcraft: How We Write Github Issues
• NYC Planning Digital: Writing Useful Github Issues