simple-query-parser v1.1.3

Query parser

This module is a simple query parser which can handle different operator.

Getting started

First install the package

npm i --save query-parser

Then you can start using the module

const queryParser = require('simple-query-parser')

// ...

How it works?

Basic value

This module needs an object with parsed queries. With express, you can get it in req.query.

For example, the following route

https://mywebsite.com/product?price=lte:25&orderBy=recent&page=3

would be translate by express in

let queryParams = {
  price: 'lte:25',
  orderBy: 'recent',
  page: '3'
}

And than translate by query parser like this:

const queryParser = require('query-parser')

let parsedParams = queryParser.parse(queryParams)

// parseParams contains
[{
  key: 'price',
  value: 25,
  comparator: '<='
}, {
  key: 'orderBy',
  value: 'recent',
  comparator: '='
}, {
  key: 'page',
  value: 3,
  comparator: '='
}]

If your values could be convert to int or float number, query-parser will do it automatically.

Array value

Simple query parser also handle arrays.

In the URL, add a coma between all your values and this will generate an array.

https://mywebsite.com/product?type=white,yellow,pink

With this URL, query parser will return the following object:

const queryParser = require('query-parser')

let parsedParams = queryParser.parse(queryParams)

// parseParams contains
[{
  key: 'type',
  value: ['white', 'yellow', 'pink'],
  comparator: 'in'
}]

Compators

Here is the list of comparator.

lte -> <=
lt -> <
gte -> >=
gt -> >
df -> !=
eq -> =
lk -> LIKE

Note: If you choose to use the lk comparator, a % will be added on both side of your value.

Limit

Your keys can only contains letter or number, if there are special caracters in it, it will be skipped.

This route

https://mywebsite.com/product?order;By=recent&page=3

will at the end be transformed in this array.

[{
  key: 'page',
  value: 3,
  comparator: '='
}]