qs2mongo

qs2mongo

Querystring to mongo mapper

Builds filters, projections and options for mongoose queries

• In your querystring:
  • attributes=comma,separated,fields maps to projection { comma: 1, separated: 1, fields: 1 }
  • limit=1,offset=2 maps to options { limit: 1, offset: 2 }
  • Sorts
    • Ascending: sort=field maps to options { sort: { field: 1 } }
    • Descending: sort=-field maps to options { sort: { field: -1 } }
  • Any other key maps to a mongo filter. Available options are:
    • strict: key=value is { key: value }
    • not strict: key=value is { key: /value/gi }
    • or: key,anotherKey=value is $or: [{key:value}, {anotherKey:anotherValue}]
    • unary operators: key__gt=value is {key: $gt: "value"}

Basic usage

Qs2Mongo = require ("qs2mongo")
qs2mongo = new Qs2Mongo()
#... 
anEndpoint: (req, res): =>
  { filters, projection, options } = qs2mongo.parse req

Usage as middleware

Qs2Mongo = require ("qs2mongo")
config = ...
qs2mongo = new Qs2Mongo config
#... 
router.use qs2mongo.middleware

#... 
anEndpoint: (req, res): =>
  { filters, projection, options } = req.mongo

Config

  {
    defaultSort, 
    idField = "id", 
    multigetIdField = "_id", 
    filterableBooleans = [], 
    filterableDates = [], 
    omitableProperties = Qs2Mongo.defaultOmitableProperties
  }

Specify types of querystring keys

qs2mongo = new Qs2Mongo
  filterableBooleans: ["aBooleanField","anotherBooleanField"]
  filterableDates: ["aDateField","anotherDateField"]