/search-index

A persistent, network resilient, full text search library for the browser and Node.js

Primary LanguageJavaScriptMIT LicenseMIT

search-index

A streaming, network resilient, persistent full-text search library 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

const getData = function(err, myIndex) {
  readStreamOfDocuments                   // <- a stream of documents to be indexed
    .pipe(myIndex.defaultPipeline())      // <- an extentable document processing pipeline
    .pipe(myIndex.add())                  // <- myIndex is a search index that can now be queried
}
require('search-index')(options, getData) // <- make a new index

search-index is a freetext search library for JavaScript. You can use it to drop fantabulous search functionality into your javascript applications

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

For the impatient

API

Documentation

Release notes

  • 0.7.0 : new constructor
  • 0.8.0 : new search API
  • 0.9.0 : Streaming API