Module

x/fuse/README.md

Lightweight fuzzy-search, in JavaScript
Very Popular
Go to Latest
File

Fuse.js logo

Version Downloads Contributors License

Supporting Fuse.js

Fuse.js is an Apache License open source project. Maintaining and updating it takes up a good chunk of time, and there’s still plenty of work to do. To be able to provide the project with the attention it deserves, I decided to experiment with sponsorship and/or support. If this works out, I can route the chunk of time that is usually spent on lucrative endeavors to this project.

If you’d like to join the list of these awesome backers, please consider:

Special Sponsors

[Get your company name here]


Introduction

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

Documentation

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

Installation

NPM

NPM is the recommended installation method. It pairs nicely with a CommonJS module bundler such as Webpack or Browserify.

# latest stable
$ npm install --save fuse.js

CDN

Available on cdnjs (see the latest version on the Releases page).

Contributing

Coding conventions

Code should be run through Standard Format.

Testing

Before submitting a pull request, please add relevant tests in test/index.js, and execute them via npm test.