<script src="/path/to/fuzzy.js"></script><script> console.log(fuzzy); // Object > // filter: function (pattern, arr, opts) { // match: function (pattern, string, opts) { // test: function (pattern, string) {</script>
Use it
Padawan: Simply filter an array of strings.
var list = ['baconing', 'narwhal', 'a mighty bear canoe'];var results = fuzzy.filter('bcn', list)var matches = results.map(function(el) { return el.string; });console.log(matches);// [ 'baconing', 'a mighty bear canoe' ]
Jedi: Wrap matching characters in each string
var list = ['baconing', 'narwhal', 'a mighty bear canoe'];var options = { pre: '<', post: '>' };var results = fuzzy.filter('bcn', list, options)console.log(results);// [// {string: '<b>a<c>o<n>ing' , index: 0, score: 3, original: 'baconing'},// {string: 'a mighty <b>ear <c>a<n>oe', index: 2, score: 3, original: 'a mighty bear canoe'}// ]
Jedi Master: sometimes the array you give is not an array of strings. You can
pass in a function that creates the string to match against from each element
in the given array
Add unit tests for any new or changed functionality. Lint, test, and minify using make, then shoot me a pull request.
Release History
v0.1.0 - July 25, 2012
Initial Release
v0.1.1 - September 19, 2015
Fix broken links in package.json
Fix examples
v0.1.2 - September 25, 2016
Exact matches get the highest score. #15
Add TypeScript typings #21
Better error handling for invalid input #13
Smaller bower install footprint #22
v0.1.3 - October 1, 2016
Fix blocking bug in React Native #27
License
Copyright (c) 2015 Matt York
Licensed under the MIT license.
TODO
Search improvement: behave a bit more like sublime text by getting
the BEST match in a given string, not just the first. For example,
searching for 'bass' in 'bodacious bass' should match against 'bass',
but it currently matches like so: <b>od<a>ciou<s> ba<s>s. There is
a test already written, just need to implement it. Naive O(n^2) worst
case: find every match in the string, then select the highest scoring
match. Should benchmark this against current implementation once implemented
Also, "reactive rice" would be <r><e>active r<i><c>e
Search feature: Work on multiple strings in a match. For example, be able
to match against 'stth' against an object { folder: 'stuff', file: 'thing' }
Async batch updates so the UI doesn't block for huge sets. Or maybe Web Workers?
Performance performance performance!
// [ '<b>a<c>o<n>ing', 'a mighty <b>ear <c>a<n>oe' ]