GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → GitbookIO → Filterable

GitbookIO / Filterable

Licence: apache-2.0
Parse and convert GitHub-like search queries in Node.JS

Programming Languages

javascript
184084 projects - #8 most used programming language

Filterable

Build Status NPM version

Filterable is a Node.JS module to parse GitHub-like search queries, for example: cats stars:>10. It can generate MongoDB or Elasticsearch queries.

This module is perfect for integrating complex search (like GitHub search) into your application. It integrates perfectly with MongoDB but can also easily be adapted to other databases.

Queries

Type Example
Query for tags cat
Query for multiple tags cat dog, "Hello World"
Exclude results containing a certain word cat NOT dog
Query for equality username:Samypesse, name:"Samy Pesse"
Query for values greater than another value stars:>10, stars:>=10
Query for values less than another value stars:<100, stars:<=100
Mix query for tags and condition cat stars:>10 stars:<100
Filter qualifiers based on exclusion cats stars:>10 NOT language:javascript

How to use it?

Install it using:

$ npm install filterable

Parse a query string:

var filterable = require("filterable");

var query = filterable.Query('cats stars:>10')
    .parse();

Output query for a database:

var mongQuery = query.toMongo();

Filter and customize queries using QueryBuilder:

var builder = filterable.QueryBuilder({
    // Field using when quering with text
    textField: 'description'
});

// Define mapping, by default all fields are accepted and piped as string
builder.field('stars', {
    type: Number
});

// Reject a field
builder.reject('email');


// Parse queries (return a Query object)
var q1 = builder.parse('Hello world')
var q2 = builder.parse('cats stars:>10');
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].