Skip to content

RawQueryParams

@tsed/platform-params

Usage

typescript
import { RawQueryParams } from "@tsed/platform-params";

See /packages/platform/platform-params/src/types/decorators/queryParams.ts.

Overview

ts
function RawQueryParams(expression: string): ParameterDecorator;
export function RawQueryParams(options: Partial<ParamOptions>): ParameterDecorator;
export function RawQueryParams(): ParameterDecorator;
  • expression (string): The path of the property to get.

Description

RawQueryParams return the value from request.query object.

Any validation and transformation are performed on the value. Use pipes to validate and/or transform the value.

Example

typescript
@Controller('/')
class MyCtrl {
   @Get('/')
   get(@RawPathParams() params: any) {
      console.log('Entire params', params);
   }

   @Get('/')
   get(@RawPathParams('id') id: string) {
      console.log('ID', id);
   }
}

For more information on deserialization see converters page.

Released under the MIT License.