Merge with develop.

Author: douglasrafael

README.md

@@ -47,27 +47,26 @@ app.get('/', (req, res) => {
 #### The middleware uses the following defaults:
 ```js
 options = {
+    use_page: false,
+    client_db: 'mongodb',
+    date_field: {
+      start_at: 'created_at',
+      end_at: 'created_at'
+    },
     default: {
+        fields: {},
+        sort: {},
+        filters: {},
         pagination: {
             limit: Number.MAX_SAFE_INTEGER,
             skip: 0,
             page: 1
-        },
-        fields: {},
-        sort: {},
-        filters: {}
-    },
-    use_page: false,
-    client_db: 'mongodb',
-    date_field: date_field: {
-      start_at: 'created_at',
-      end_at: 'created_at'
-  }
+        }        
+    }    
 }
 ```
 If the options are not provided, the default values will be used for the treatment of queries strings.
 
-
 ### 2. Using custom configurations:
 ```js
 const express = require('express')
@@ -80,7 +79,7 @@ app.use(qs({
   date_field: {
       start_at: 'timestamp',
       end_at: 'timestamp'
-  }
+  },
   default: {
       fields: {name: 1 , age: 1, number: 1, _id: 0},
       sort: { created_at: 'desc' },
@@ -110,11 +109,13 @@ app.use(qs({
 
 For more details, access the [wiki](https://github.com/nutes-uepb/query-strings-parser/wiki/2.-Usage-Examples) page.
 
-### 3. Supported Query Strings
+## Supported Query Strings
 
 For informations and details about the supported query strings, access the [wiki](https://github.com/nutes-uepb/query-strings-parser/wiki/3.-Supported-Query-Strings) page.
 
+## New Features
 
+- Support for parser functions. For informations and details about parser functions, access the [wiki](https://github.com/nutes-uepb/query-strings-parser/wiki/4.-Parsers) page.
 ## Future Features
 - ¹Support for relational databases such as MySQL, PostgreSQL and SQLite.
 

index.d.ts

@@ -4,13 +4,23 @@ export = queryStringsParser
 declare namespace queryStringsParser {
     export interface QueryStringsParser {
         (options?: IOptions): any
+
+        parseFields(query?: string | object, options?: IOptions): any
+
+        parseSort(query?: string | object, options?: IOptions): any
+
+        parsePagination(query?: string | object, pagination?: IPagination, use_page?: boolean): any
+
+        parseFilter(query?: string | object, options?: IOptions): any
+
+        parseDate(query?: string | object, date_fields?: IDateFields): any
     }
 
     export interface IOptions {
         default?: IDefault
         use_page?: boolean
         client_db?: string
-        date_field?: string
+        date_fields?: IDateFields
     }
 
     export interface IDefault {
@@ -25,4 +35,9 @@ declare namespace queryStringsParser {
         skip?: number
         limit?: number
     }
+
+    export interface IDateFields {
+        start_at?: string
+        end_at?: string
+    }
 }

index.js

@@ -2,7 +2,27 @@
 
 const read = require('./lib/read')
 
+
 exports = module.exports = function (params) {
-    read.set_default()
-    return read.options(params)
+    return read.parser(params)
+}
+
+exports = module.exports.parseFields = function (_query, _default) {
+    return read.parseFields(_query, _default)
+}
+
+exports = module.exports.parseSort = function (_query, _default) {
+    return read.parseSort(_query, _default)
+}
+
+exports = module.exports.parsePagination = function (_query, _default, _use_page) {
+    return read.parsePagination(_query, _default, _use_page)
+}
+
+exports = module.exports.parseFilter = function (_query, _default) {
+    return read.parseFilter(_query, _default)
+}
+
+exports = module.exports.parseDate = function (_query, _default) {
+    return read.parseDate(_query, _default)
 }

lib/mapper/fields.js

@@ -1,11 +1,14 @@
 'use strict'
 
 function fields(query, options) {
+    var result = {}
     if (query.fields) {
         if (query.fields instanceof Array) {
-            return processQuery(query.fields.join(','))
+            result = processQuery(query.fields.join(','))
+        } else {
+            result = processQuery(query.fields)
         }
-        return processQuery(query.fields)
+        return validate_fields(result, options.default.fields)
     }
     return options.default.fields
 }
@@ -21,6 +24,10 @@ function processQuery(query) {
     return elems
 }
 
+function validate_fields(_values, _default) {
+    return Object.assign(_values, _default)
+}
+
 exports = module.exports = {
     fields: fields
 }