Skip to content

A persistent full text search engine for the browser and Node.js

License

Notifications You must be signed in to change notification settings

ihenshaw/search-index

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

search-index

A persistent full text search engine for the browser and Node.js

Join the chat at https://gitter.im/fergiemcdowall/search-index NPM version NPM downloads MIT License Build Status js-standard-style

var searchIndex = require('search-index')

searchIndex(options, function(err, si) {
  si.add(data, opt, 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 fantabulous 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, so search-index is really portable.

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

For the impatient

Documentation

Examples

API

Release notes

  • 0.7.0 : new constructor
  • 0.8.0 : new search API

About

A persistent full text search engine for the browser and Node.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%