HeaderParams

@tsed/platform-params

Usage

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

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

Overview

function HeaderParams(expression: string, useType: Type<any>): ParameterDecorator;
export function HeaderParams(expression: string): ParameterDecorator;
export function HeaderParams(useType: Type<any>): ParameterDecorator;
export function HeaderParams(options: Partial<ParamOptions>): ParameterDecorator;
export function HeaderParams(): ParameterDecorator;

• expression (string): The path of the property to get.

Description

HeaderParams return the value from request.get() method.

Example

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

   @Get('/')
   get(@HeaderParams('x-token') token: string) {
      console.log('token', id);
   }
}