lunr

What is lunr?

The lunr npm package is a small, full-text search library for use in a web browser or Node.js environment. It provides a simple search interface for retrieving documents based on a search query. Lunr is designed to be easy to set up and use, without the need for a dedicated backend search server.

What are lunr's main functionalities?

Creating an index

This code sample demonstrates how to create a search index with lunr. Fields to be indexed are specified, and documents are added to the index.

const lunr = require('lunr');
const idx = lunr(function () {
  this.field('title');
  this.field('body');
  this.add({
    'title': 'Example',
    'body': 'This is an example.'
  });
});

Searching the index

Once an index has been created, you can search it using a query string. This code sample searches for the term 'example' in the index.

const results = idx.search('example');

Serializing and loading an index

Lunr allows you to serialize an index to JSON and load it back. This is useful for saving the index to disk or sending it over the network.

const serializedIndex = JSON.stringify(idx);
const loadedIndex = lunr.Index.load(JSON.parse(serializedIndex));

Other packages similar to lunr

elasticlunr

Elasticlunr is a lightweight full-text search engine in JavaScript. It is based on lunr.js but provides more flexibility and is faster than lunr.js. It allows for configuring similarity tuning, custom scoring, and has a chainable API.

fuse.js

Fuse.js is a powerful, lightweight fuzzy-search library with a rich set of options. It is different from lunr in that it performs 'fuzzy' searches, which can find matches even when the search terms are not exactly the same as the indexed terms.

js-search

Js-search is a library that enables efficient search in JavaScript and JSON objects. It supports various search strategies and is more customizable than lunr, allowing for indexing and searching in multiple languages.

algoliasearch

Algolia is a hosted search API that provides a full suite of search features. It is more feature-rich and scalable than lunr, offering real-time search, typo tolerance, and geo-search out of the box. Unlike lunr, it requires an external service and is not a purely client-side solution.

README

Lunr.js

A bit like Solr, but much smaller and not as bright.

Example

A very simple search index can be created using the following:

var idx = lunr(function () {
    this.field('title', { boost: 10 })
    this.field('body')
})

Adding documents to be indexed is as simple as:

var doc = {
    "title": "Twelfth-Night",
    "body": "If music be the food of love, play on: Give me excess of it…",
    "author": "William Shakespeare",
    "id": 1
}    
idx.add(doc)

Then searching is as simple:

idx.search("love")

This returns a list of matching documents with a score of how closely they match the search query:

[{
    "ref": 1,
    "score": 0.87533
}]

API documentation is available, as well as a full working example.

Description

Lunr.js is a small, full-text search library for use in the browser. It indexes JSON documents and provides a simple search interface for retrieving documents that best match text queries.

Why

For web applications with all their data already sitting in the client, it makes sense to be able to search that data on the client too. It saves adding extra, compacted services on the server. A local search index will be quicker, there is no network overhead, and will remain available and useable even without a network connection.

Installation

Simply include the lunr.js source file in the page that you want to use it. Lunr.js is supported in all modern browsers.

Browsers that do not support ES5 will require a JavaScript shim for Lunr to work. You can either use Augment.js, ES5-Shim or any library that patches old browsers to provide an ES5 compatible JavaScript environment.

Contributing

Contributions are very welcome, to make the process as easy as possible please follow these steps:

• Open an issue detailing the bug you've found, or the feature you wish to add. Simplified working examples using something like jsFiddle make it easier to diagnose your problem.
• Add tests for your code (so I don't accidentally break it in the future)
• Don't change version numbers or make new builds as part of your changes
• Don't change the built versions of the library, only make changes to code in the lib directory'

Developer Dependencies

A JavaScript runtime is required for building the library.

Run the tests with, this will use phantomjs to run the tests:

make test

The tests can also be run in the browser by starting the test server:

make server

This will start a server on port 3000, the tests are then available at '/test'

Changelog

0.5.3

• Correctly stem words ending with the letter 'y' #84 thanks Mihai Valentin
• Improve build tools and dev dependency installation #78 thanks Ben Pickles