Full Text Search Light is a pure JS full text search engine with an ultrafast search and the following commands:

• Init
• Add
• Search
• Remove

You can add every kind of data, also complex objects.

Install

From NPM

npm install full-text-search-light

From GitHub

npm install git+/~https://github.com/frankred/node-full-text-search-light.git

Documentation

Init

var db = require('full-text-search-light');
var search = new db('my-db');   // name is optional
search.init();

You can also change some configuration values according to the full text search.

var db = require('full-text-search-light');
var search = new db();

// Make search case insensitive
// Has to be done before init()
// Can't be changed after init()
search.ignore_case(true);   // default = true

// Activate debug output
// Makes your fulltext search much more slower
// Should always be done only for developement reasons
search.debug(true);   // default = false

// Change the amount of indexes
// The more indexes you have the faster can be your search
// But the slower the 'add' method  gets
search.index_amount(8);   // default = 12

/*
Defaults are
  index_amount: 12,
  ignore_case: true,
  debug: falses
*/

// Init the index, has to be done before adding values or objects.
search.init();

Add

// Add values
search.add('Peter');
search.add('Paul');
search.add('Maria');

You can also add objects or arrays to the search. Every child value will be added to the search, no mather if its an array or object.

// Add objects
var obj = {
    name: 'Alexandra',
    age: 27,
    student: true,
    hobbies: ['Tennis', 'Football', 'Party'];
    car: {
        make: 'Volvo',
        year: 2012,
        topspeed: 280
    }
};

search.add(obj);

Add with filter

If you want to ignore fields you can over give a filter function. If you want to ignore a field or value just return false. If you return true or everything else the field is added to the index.

// Add filter, this function will be called on every single field
// If you don't want to add a field to the search just return false
var filter = function (key, val) {
    // Return false if you want to ignore field
    if (key == 'student' || key == 'topspeed') {
        return false;   // Ignore field
    }

    return true;    // Accept field
};

search.add(obj, filter);

Search

var results = search.search('p');
// results = ['Peter', 'Paul']

Remove

You can remove objects or values out of the search by saving the id which is returned from the add method.

// Add returns an id
var f = search.add("Frank");

// With that id you can remove the value from the search
search.remove(f);

// Returns an array with all result objects
var result = search.search('pau');
// result: ['Paul']

Functions

This are all functions that can be used.

name

• search.name() - Return the name
• search.name('new-name') - Set the name

index_amount

• search.index_amount() - Return the index amount
• search.name('new-name') - Set the index amount

debug

• search.debug(true) - Enable debugging
• search.name(false) - Disable debugging

add

• search.add('Just a string value') - Add a string to the search, returns a unique id
• search.add(obj) - Add a object to the search, returns a unique id

If you add numbers or booleans to the search they will be converted to strings.

• search.add(false) - Add booelan to the search (ok this does not really make sense, but it works.), returns a unique id
• search.add(42) - Add number to the search, returns a unique id

search

• search.search('value') - Search for the string 'value'. Returns the results of the data as an array

remove

• search.remove(1337) - Remove the data with the id 1337 from the search. This id was returned by adding a value or obj.

drop

• search.drop() - Drops the search database and resets all data. The configuration is kept.

To do

• Add store and load function to serialize the full text search index.

Run tests

You need mocha installed globally:

npm install -g mocha

Now you can run tests if you navigate to project root:

mocha test

##License MIT Free Software, Hell Yeah!