@comodinx/query-parser/README.md

@comodinx/query-parser is a module for parser query parameters on ORM object (sequelize).

# Query parser

@comodinx/query-parser is a module for parser query parameters on ORM object (sequelize).

## Index

* [Download & Install][install].
* [How is it used?][how_is_it_used].
* [Tests][tests].

## Download & Install

### NPM
```bash
$ npm install @comodinx/query-parser
```

### Source code
```bash
$ git clone https://gitlab.com/comodinx/query-parser.git
$ cd query-parser
$ npm install
```

## How is it used?

This section was designed to facilitate the interpretation of query parameters.

## **What parameters are accepted?**  

### **Pagination**  

| Name     | Type   | Default Value | Description                                         |
|:---------|:-------|:--------------|:----------------------------------------------------|
| page     | number | `1`           | Indicates which page of the list should be returned. |
| pageSize | number | `null`        | Indicates the number of records per page.          |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Sorting**  

| Name   | Type   | Default Value | Description                                        |
|:-------|:-------|:--------------|:---------------------------------------------------|
| order  | string | `null`        | Sorting to apply in the search results.           |
|        |        |               | Example,                                          |
|        |        |               | `createdAt-DESC`                                  |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Grouping**  

| Name   | Type   | Default Value | Description                                         |
|:-------|:-------|:--------------|:----------------------------------------------------|
| group  | string | `null`        | Grouping to apply in the search results.           |
|        |        |               | Example,                                           |
|        |        |               | `platform`                                         |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Filtering**  

| Name    | Type   | Default Value | Description                                          |
|:--------|:-------|:--------------|:-----------------------------------------------------|
| filters | string | `null`        | Filters to apply in the search.                     |
|         |        |               | All table fields are applicable for filtering.      |
|         |        |               | Example,                                            |
|         |        |               | `statusId eq 1`                                     |  

> 💡 For more details on how filters work and their syntax, [check this link](https://www.npmjs.com/package/@comodinx/query-filters).  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Relationships**  

| Name    | Type   | Default Value | Description                                         |
|:--------|:-------|:--------------|:----------------------------------------------------|
| include | string | `null`        | Relationships to include in the search results.    |
|         |        |               | Example,                                           |
|         |        |               | `status,r-products`                                |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Fields**  

| Name   | Type   | Default Value | Description                                         |
|:-------|:-------|:--------------|:----------------------------------------------------|
| fields | string | `"*"`         | Fields to include in the search results.           |
|        |        |               | Example,                                           |
|        |        |               | `id,statusId`                                      |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

### **Extras**  

| Name   | Type   | Default Value | Description                                         |
|:-------|:-------|:--------------|:----------------------------------------------------|
| extras | string | `null`        | Additional fields to include in the search results. |
|        |        |               | Example,                                           |
|        |        |               | `category,brand`                                   |  

<hr/>  
<p align="right">(<a href="#top">go to top</a>)</p>  

## **Tests**  

For more concrete examples, **I INVITE YOU TO CHECK THE TESTS :)**  

### **Run unit tests**  
```sh
npm test
```  

<p align="right">(<a href="#top">go to top</a>)</p>  


<!-- deep links -->
[install]: #download--install
[how_is_it_used]: #how-is-it-used
[tests]: #tests