Nest TypeOrm Query Parser

A TypeOrm query string parser to be used in applications developed with NestJS.

Summary

• Prerequisites
• Installing
• Usage

• License
• Authors

Prerequisites

As the name of the library suggests, it was built to work together with the NestJS framework.

Installing

Use the follow command:

npm i --save nest-typeorm-query-parser

Usage

There are two ways to use the parsers available in this library: as a ParamDecorator or as a MethodDecorator.

If you want to use it as a ParamDecorator, just add the tag referring to the Parser to be used as a method parameter. Example:

import { Get } from '@nestjs/common';
import { Controller } from '@nestjs/common';
import { ResourceService } from './resource.service';
import { TypeOrmQuery, TypeOrmQueryModel } from 'nest-typeorm-query-parser';

@Controller('resources')
export class ResourceController {
  constructor(private readonly _service: ResourceService) {}

  @Get()
  public find(@TypeOrmQuery() query: TypeOrmQueryModel) {
    return this._service.find(query);
  }
}

It can also be used as a MethodDecorator. Just use the tag referring to the Parser to be used as the method decorator. Example:

import { Injectable } from '@nestjs/common';
import { TypeOrmQueryParser, TypeOrmQueryModel } from 'nest-typeorm-query-parser';

@Injectable()
export class ResourceService {
  @TypeOrmQueryParser()
  public find(query: TypeOrmQueryModel) {
    return [];
  }
}

NOTE: When using the library as a MethodDecorator, you can receive other arguments in the method in question, but the query has to be passed as the first argument of the function, so that the treatment is done properly.

Usage

More details about usage as soon as possible.

Rules

• For pagination, you should use limit, skip and page only;
• For ordination, you should use sort only;
• Parameters never contain characters that don't fit the regex /[^A-z0-9_.]/g;
• Filter values never contain characters that don't fit the regex /[^\w\s@.-:]/g;

Observations

This library is generic. This means that it handles the query based on the query object itself. Therefore, it is not possible to control events such as filter parameters with types incompatible with the types defined in the base. Use proper queries for your API, to prevent implementation errors from being thrown into your app.

Practical Examples

Check out how the configuration of the library in an API works in practice in this project.

License

Distributed under the Apache License 2.0. See LICENSE for more information.

Authors

• Lucas Rocha - Initial Work.