fuzzr v0.3.1

Fuzzr

Fuzzr is an incredibly fast fuzzy searcher compiled for browser use. This library is written in rust and utilizes the popular skim algorithm used in the skim command line search. The algorithm is provided by the fuzzy-matcher crate by lotabout. I merely provided the wasm bindings.

Usage

const Fuzzr = (await import('fuzzr')).Fuzzr

const collection = [
  { name: 'Apple' },
  { name: 'Orange' },
  { name: 'Pineapple' },
  { name: 'Pear' }
]

const fuzzr = new Fuzzr(collection, {
  surroundMatchesWith: ['<strong>', '</strong>'],
  // only necessary when not passing a collection of Strings:
  toString: ({ name }) => name,
})

fuzzr.search('Ale')
/*
[
  {
    item: { name: 'Apple' },
    score: 42,
    formatted: '<strong>A</strong>pp<strong>le</strong>'
  },
  {
    item: { name: 'Pineapple' },
    score: 42,
    formatted: 'Pine<strong>a</strong>pp<strong>le</strong>'
  }
]
*/

Results are ordered in descending order by score. If the score is equal, the order of the elements in the collection is preserved.