Simple string query language Node.js module

Overview

Query a string by creating a query object, instead of having to contruct a regex or parse anything.

Every query object has a 'type' field, one of:

['AND', 'OR', 'NOT', 'WITHIN', 'MATCH', 'EXACT']

As well as a type field, a query object will contain either 1 or 2 'arg' fields.

Some examples of query objects:

// Match a string if it contains the word 'film'
var query1 = {
    type:"MATCH",
    arg1:"film"
};

// This query matches a string if it contains both 'FILM' (only in uppercase) and 'amazing' (any case)
var query2 = {
    type:"AND",
    arg1:{
        type:"EXACT",
        arg1:"FILM"
    },
    arg2:{
        type:"MATCH",
        arg1:"amazing"
    }
}

// This query matches if the string does not contain both 'FILM' (uppercase) and 'amazing' (any case)
var query4 = {
    type:"NOT",
    arg1:query2
}


// More complex queries can then be made by nesting query objects
var query5 = {
    type:"OR",
    arg1:query1,
    arg2:query2
}

---

Usage:

var query = require('node-text-match');

var exampleQuery = {
    type:"EXACT",
    arg1:"AMAZING"
};

var testString = "That film was AMAZING";

query.parseQuery(testString, exampleQuery);
--> true

AND & OR are binary operators and are of the following form:

{
    type:"AND",
    arg1:{
        //another query object
    },
    arg2:{
        //another query object
    }
};

{
    type:"OR",
    arg1:{
        //another query object
    },
    arg2:{
        //another query object
    }
};

WITHIN is also a binary operator, but requires an extra parameter:

// matches strings containing the word 'film' within 3 words of 'good'
{
    type:"WITHIN",
    arg1:"film",
    arg2:"good",
    within:3
};

EXACT, MATCH and NOT are uniary operators:

// loose match
{
    type:"MATCH",
    arg1:"amazing!!"
}

// exact match
{
    type:"EXACT",
    arg1:"AMAzing"
}

// ignore strings that return true for arg1 query
{
    type:"NOT",
    arg1:{
        type:"EXACT",
        arg1:"film"
    }
}