An overview on properly crafting an Http request in a NestJS controller

Question

An overview on properly crafting an Http request in a NestJS controller

I'm currently setting up a NestJS controller and have been using any as the type for the request. Is there a more precise type I could use to ensure stronger typing?

@Controller('endpoint')
@UsePipes(new MongoSanitizePipe())
export class RequestController {
    constructor(private service: Service) {}

    @Post('post')
    async onAction(
        @Body() body: RequestBody,
        @Request() request: any,
    ): Promise<void> {
        return this.service.onAction(body, request.headers);
    }
}

What experimentation have you done and what outcome were you expecting?

I've searched for a specific HttpRequest type without success.
I hoped to find a way to properly define its type.

typescript nestjs

Answer 1

Answer №1

In the example provided by NestJs, they demonstrate the use of the example using the Request class from express. This approach is also followed in projects at my company:

import { Controller, Get, Req } from '@nestjs/common';
import { Request } from 'express';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(@Req() request: Request): string {
    return 'This action returns all cats';
  }
}

If you are utilizing fastify, there is a FastifyRequest available within the package that you can import instead.

Answer 2

In the example provided by NestJs, they demonstrate the use of the example using the Request class from express. This approach is also followed in projects at my company:

import { Controller, Get, Req } from '@nestjs/common';
import { Request } from 'express';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(@Req() request: Request): string {
    return 'This action returns all cats';
  }
}

If you are utilizing fastify, there is a FastifyRequest available within the package that you can import instead.

An overview on properly crafting an Http request in a NestJS controller

Answer №1

Similar questions

Guide on importing JavaScript into TypeScript without using noImplicityAny and while not allowing Js

Resetting a Template-Driven form in Angular using programming techniques

Can you explain how parameters are being transferred to the onClick function?

Having trouble assigning the class property in Angular 5

Configuring Monaco Editor in React to be in readonly mode

Execution issue with Typescript function

Setting the default value for a useRef<HTMLInputElement> in ReactJs with Typescript

The Fusion of Apollo GraphQL Server and TypeScript: A Match Made

The 'replace' property is not found in the 'IData' type. What is the missing piece?

The combination of TypeScript decorators and Reflect metadata is a powerful tool for

Is it possible to dynamically synchronize object types in TypeScript based on each other?

ReactTS: Tips for organizing child components within a "container component"

Tips for using Cookie Service in Angular 2

How to prevent duplicate database entries in Angular forms?

Universal key and attribute retrieval function

Why is there an error when trying to assign Type '{}' in generics typescript?

Prisma Remix is throwing a TypeError: "The function (0, import_prisma.createNote) is not defined as a function."

Prevent Angular from automatically scrolling to the top when subscribing to a timer

Creating a Type in React TypeScript that allows for null values in createContext: what you need to know

Creating a layered image by drawing a shape over a photo in Ionic using canvas