node package manager

express-query-parameters

Express Query Parameters

npm downloads dependencies npm-issues js-standard-style Build Status js-standard-style

What is Express Query Parameters

This package is used to parse general queries and any other apdapter you want or create to add to your express routes. By using this package as middleware app.user(queryParameters.middleware()) you will be able to have all parsed parameters waiting for you at req.queryParameters to do and search as you please.

Usage

var express = require('express')
var app = express()
var queryParameters = require('express-query-parameters')({
  settings: {
    schema: ['name', 'title', 'content', 'roles', 'email'],
    adapter: 'mongoose' // <object|string:supported adapter(MONGOOSE)> 
  }
})
app.use(queryParameters.middleware())
app.get('/query', function (req, res, next) {
  res.send(req.queryParameters)
})
app.listen(3000)
// Or 
var parseData = queryParameters.parse(options)

Documentation

  • Construct queryParameters({}) - allows you to set the options
  • Config queryParameters.config({}) - give you a way to get or set the config
  • Middleware - queryParameters.middleware() - Middlware pulls from req.query for query and from the options set in the contruct & config
  • Parse - var data = queryParameters.parse(queryObj)

Options

{
  query: {
    sort: '', // allows you to sort based of the schema 
    filter: {}, // allows you to sort based of the schema 
    limit: 20, // allows you to set a max limit/default limit 
    skip: 0,  // allows you to set a base skip  
    select: '' // allows you to select fields based of the schema  
  },
  settings: {
   // set your fields you wish to check agains that the user can query on 
    schema: ['myFields', 'namesToFilterOn', 'email', 'content', 'ex'] 
  }
}

Adapters

We currently support custom adapters or you can use mongoose our home grown adapter

Mongoose

Check the options out below on what you can set as your defaults for the mongoose adapter.

Options
{
  populateId: '',
  populateItems: '',
  limitToPopulateId: '',
  limitToPopulateItems: '',
  deepPopulate: '',
  where: '',
  gt: false,
  gte: false,
  lte: false,
  lt: false,
  in: false,
  ne: false,
  nin: false,
  regex: false,
  options: false,
  size: false,
  all: false,
  equals: false,
  find: false,
  or: false,
  nor: false,
  and: false
}

SQL

No Support Yet

Custom

More docs to come here but we will leave a example

var OPTIONS = {
  lean:true,
  gt:'test'
}
function MongooseAdapter (query) {
  var self = this
 
  return {  // NOTE you must return a list of tasks  - follow this https://www.npmjs.com/package/run-auto 
    lean: function (cb) {
      cb(null, query.lean || OPTIONS.lean)
    },
    gt: function (cb) {
      cb(null, query.gt || OPTIONS.gt)
    }    
  }
}
 
MongooseAdapter.afterParse = function (result, options) {
  //if you need to update the result do it right here we have also supplied the entire options 
}
 
MongooseAdapter.options = OPTIONS
 
module.exports = MongooseAdapter

Credit From Buildreq Query.js

License

The MIT License (MIT)

Copyright (c) 2014-2017 Green Pioneer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Created by Green Pioneer

This is on GitHub

Find us on GitHub

Find us on Twitter

Find us on Facebook

Find us on The Web