brianreavis / sifter.js

A library for textually searching arrays and hashes of objects by property (or multiple properties). Designed specifically for autocomplete.
1.09k stars 125 forks source link

Document options.score #23

Open franklin-ross opened 9 years ago

franklin-ross commented 9 years ago

In the body of the Sifter.prototype.search function are the following lines:

// generate result scoring function
fn_score = options.score || self.getScoreFunction(search);

I take this to mean we can supply a custom score function, which is pretty neat, but undocumented on the project GitHub page. It would be better to have it documented.

avk commented 9 years ago

+1