fuse-immutable

fuse-immutable

Lightweight fuzzy-search for Immutable.js (Based on Fuse.js by krisk)

Table of Contents

• How is this different than Fuse.js?
• Contributing
  • Coding conventions
  • Testing

How is this different than Fuse.js?

The obvious difference is that it works with Immutable.js data. Instead of an array for your list argument, pass in an Immutable.List.

One other key difference is the results when using tokenize and matchAllTokens together. Fuse.js will return items that have a single value that matches all tokens. fuse-immutable returns items where each token can be found somewhere in the item.

import { fromJS } from 'immutable'
import Fuse from 'fuse-immutable'

const list = fromJS([{
  title: 'Jackson',
  author: 'Steve Pearson',
  tags: ['Kevin Wong', 'Victoria Adam', 'John Smith']
}, {
  title: 'The life of Jane',
  author: 'John Smith',
  tags: ['Jane', 'Jackson', 'Sam']
}, {
  title: 'The life of John',
  author: 'Jane Wong',
  tags: ['Victoria Adam', 'John Pearson']
}])

const options = {
  threshold: 0,
  tokenize: true,
  matchAllTokens: true,
}

const fuse = new Fuse(list, options)

console.log(fuse.search('Jackson Wong'))
// List [
//   Map {
//    "title": "Jackson",
//    "author": "Steve Pearson",
//    "tags": List [ "Kevin Wong", "Victoria Adam", "John Smith" ]
//   }
//  ]

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.

Changelog

Version 2.0.0

• Modified search algorithm to search individual words AND the full string, computing the final score as a function of both. This yields better scoring accuracy (#41)
• Changed exact substrings to not have a score of zero. That is searching for "hell" in "hello" will not yield a score of zero, while searching for "hello" will (#63)
• Added verbose option, which will print to the console useful information, mostly for debugging
• Improved code structure.
• Added version information within Fuse itself
• Added this Changelog (#64)
• Added fallback when pattern length is greater than machine word length (i.e, > 32 characters) (#38)
• Allowed results with a value of 0 to be returned (#73)