mzilot / search-index Goto Github PK

var si = require('search-index');

si.add(opt, data, function (err) {
  //add stuff to index
});

si.search(q, function (err, searchResults) {
  //search in index
});

search-index is a freetext search library for JavaScript. You can use it to drop kick-ass search functionality into your node.js, HTML, OSX and Android applications.

You can also generate search indexes and easily share them- you could for example make an index available on bittorrent, or you could push an index out to a browser. It is really easy to move indexes around, and create decentralised search engines.

search-index uses LevelDB as a backend via the LevelUp interface. These days, LevelDB-ish databases are installed pretty much everywhere, which is why search-index is so portable.

Find out how to use the search-index module here:

• Quickstart

• Create an index
• Add documents to an index
• Search in an index
• Matchers and autosuggest
• Replicate an index

• Examples

• API reference