Package Exports

haystack-search

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (haystack-search) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Haystack

Overview

Haystack is a lightweight search / suggestion module that can be used to find similar matches to a word. Just provide a way for your users to enter their query and the source data to search (as an array, object, or string), and Haystack will return a list of approximate matches. The lower the flexibility the more strict your matches will be.

For an easy to implement UI version which includes a pre-built search field and suggestion dropdown, see Haystack UI

Installation

Using npm:

npm i haystack-search

Require Haystack in your Node project:

const Haystack = require('haystack-search');

const haystack = new Haystack(options);

Options

Option	Default	Description
`flexibility` (number)	2	"Fuzziness" of search. The lower the number, the more strict your matches will be. (If set to `0`, Haystack will only look for perfect matches)
`caseSensitive` (boolean)	false	Whether or not search is case sensitive
`exclusions` (string)	null	Add a string or regex to ignore in query
`ignoreStopWords` (boolean)	false	Ignore common stop words such as the, a, in, etc.
`stemming` (boolean)	false	Reduces tokens in a query to their base words using stemmer

Methods

haystack.search(searchTerm, source, [limit]);

Returns either an array of matches within your flexibility range, or null if there are no matches. If no limit is given, the default number of results will be 1.

haystack.tokenize(searchTerm, [delimiter]);

Returns an array of tokens. By default this splits on whitespaces, but you can define a custom delimiter to use instead.

Contributions

Contributions and suggestions for improvement are always welcome!

Fork this repo (https://github.com/AlexanderLyon/Haystack/fork)
Create your new feature branch
Commit changes and push
Create a new Pull Request

License

MIT