queryfilter

Created: 2014-05-18 23:54
Updated: 2016-10-26 05:21
License: other

README.md

QueryFilter

Build Status NPM version Dependency Status Development Dependency Status
Gittip donate button

Create query filters, stringify them, humanize them

Install

NPM

  • Use: require('queryfilter')
  • Install: npm install --save queryfilter

Browserify

  • Use: require('queryfilter')
  • Install: npm install --save queryfilter
  • CDN URL: //wzrd.in/bundle/queryfilter@0.0.4

Ender

  • Use: require('queryfilter')
  • Install: ender add queryfilter

Usage

var QueryFilter = require('queryfilter');
var queryFilter = new QueryFilter();

// whether or not we should invert this query
// boolean
queryFilter.inverse = false;

// whether or not we should exactly match the value
// boolean
queryFilter.exact = false;

// the human readable name of the field
// null/string
queryFilter.name = null;

// the key used to identify the field
// required, string
queryFilter.key = "some key";

// the data type of the field
// null/string
queryFilter.type = null;

// the operator used to compare the field with the value
// null/"bt"/"gt"/"lt"
queryFilter.operator = null;

// the value used on the field
// required, any type
queryFilter.value = "some value";

// Transformations
console.log(queryFilter.toString());
console.log(queryFilter.fromString());
console.log(queryFilter.toHumanString());

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2014+ Jed Watson jed@thinkmill.com.au (https://github.com/jedwatson)

Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more