🌊 Blazing fast, 1kb search for Javascript
JavaScript
Switch branches/tags

README.md

Wade

Blazing fast 1kb search

Build Status

Installation

NPM

npm install wade

CDN

<script src="https://unpkg.com/wade"></script>

Usage

Initialize Wade with an array of strings.

const search = Wade(["Apple", "Lemon", "Orange", "Tomato"]);

Now you can search for a query within the array, and Wade will return the index of it, along with a score.

search("App");
/*
[{
  index: 0,
  score: 1.25
}]
*/

Combined with libraries like Moon, you can create a real-time search.

Loading/Saving Data

To save data as an object, use Wade.save on your search function, and then use these later when initializing Wade.

For example:

// Create the initial search function
const search = Wade(["Apple", "Lemon", "Orange", "Tomato"]);
const instance = Wade.save(search);

// Save `instance`

Later, you can get the same search function without having Wade recreate an index every time by doing:

// Retrieve `instance`, then
const search = Wade(instance);

instance can be saved to a file using using JSON.stringify() and loaded with JSON.parse().

Processors

Wade uses a set of processors to preprocess data and search queries. By default, these will:

  • Make everything lowercase
  • Remove punctuation
  • Remove stop words

A process consists of different functions that process a string and modify it in some way, and return the transformed string.

You can easily modify the processors as they are available in Wade.config.processors, for example:

// Don't preprocess at all
Wade.config.processors = [];

// Add custom processor to remove periods
Wade.config.processors.push(function(str) {
  return str.replace(/\./g, "");
});

All functions will be executed in the order of the array (0-n) and they will be used on each document in the data.

The stop words can be configured to include any words you like, and you can access the array of stop words by using:

Wade.config.stopWords = [/* array of stop words */];

The punctuation regular expression used to remove punctuation can be configured with:

Wade.config.punctuationRE = /[.!]/g; // should contain punctuation to remove

Algorithm

First, an index is generated from the data. When performing a search, the following happens:

  • The search query is processed.
  • The search query is tokenized into keywords.
  • Each term except the last is searched for exactly and scores for each item in the data are updated according to the relevance of the term to the data.
  • The last keyword is treated as a prefix, and Wade performs a depth-first search and updates the score for all data prefixed with this term using the relevance weight for the term. This allows for searching as a user types.

In-depth explanations of the algorithm are available on the blog post and pdf.

License

Licensed under the MIT License by Kabir Shah