@nestjs/platform-express

What is @nestjs/platform-express?

The @nestjs/platform-express package is a platform-specific module for NestJS that allows the framework to work on top of the Express.js web application framework. It provides the necessary adapters and interfaces to integrate NestJS with Express, enabling developers to leverage the robust features of both NestJS and Express in their applications.

What are @nestjs/platform-express's main functionalities?

HTTP Server

This feature allows you to create an HTTP server using Express as the underlying platform for your NestJS application. The code sample demonstrates how to bootstrap a NestJS application with the Express platform.

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import * as express from 'express';

async function bootstrap() {
  const server = express();
  const app = await NestFactory.create(AppModule, server);
  await app.listen(3000);
}
bootstrap();

Middleware Configuration

This feature allows you to define and configure middleware in your NestJS application. The code sample shows how to implement a simple logging middleware using the @nestjs/platform-express package.

import { NestMiddleware, MiddlewareFunction, Injectable } from '@nestjs/common';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  resolve(...args: any[]): MiddlewareFunction {
    return (req, res, next) => {
      console.log('Request logged:', req.method, req.path);
      next();
    };
  }
}

Request Handling

This feature enables you to handle HTTP requests and interact with the request object provided by Express. The code sample illustrates how to create a controller with a route that returns a string response.

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';
  }
}

Other packages similar to @nestjs/platform-express

@nestjs/platform-fastify

Similar to @nestjs/platform-express, this package allows NestJS to work with the Fastify web framework instead of Express. It provides a different set of performance benefits and architectural choices, focusing on high performance and low overhead.

express

The express package is the underlying library that @nestjs/platform-express is built upon. It is a fast, unopinionated, minimalist web framework for Node.js and is used directly when building traditional Express applications without the additional structure and features provided by NestJS.

koa

Koa is another web framework for Node.js, similar to Express. It is designed by the same team that created Express and provides a more modern and modular approach. While there is no official NestJS package for Koa, it represents an alternative to Express in the Node.js ecosystem.

README

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest is a framework for building efficient, scalable Node.js server-side applications. It uses modern JavaScript, is built with TypeScript (preserves compatibility with pure JavaScript) and combines elements of OOP (Object Oriented Programming), FP (Functional Programming), and FRP (Functional Reactive Programming).

Under the hood, Nest makes use of Express, but also, provides compatibility with a wide range of other libraries, like e.g. Fastify, allowing for easy use of the myriad third-party plugins which are available.

Philosophy

In recent years, thanks to Node.js, JavaScript has become the “lingua franca” of the web for both front and backend applications, giving rise to awesome projects like Angular, React and Vue which improve developer productivity and enable the construction of fast, testable, extensible frontend applications. However, on the server-side, while there are a lot of superb libraries, helpers and tools for Node, none of them effectively solve the main problem - the architecture.

Nest aims to provide an application architecture out of the box which allows for effortless creation of highly testable, scalable, loosely coupled and easily maintainable applications. The architecture is heavily inspired by Angular.

Getting started

• To check out the guide, visit docs.nestjs.com. :books:
• 要查看中文 指南, 请访问 docs.nestjs.cn. :books:
• 가이드 문서는 docs.nestjs.com에서 확인하실 수 있습니다. :books:
• ガイドは docs.nestjs.comでご確認ください。 :books:

Questions

For questions and support please use the official Discord channel. The issue list of this repo is exclusively for bug reports and feature requests.

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Consulting

With official support, you can get expert help straight from Nest core team. We provide dedicated technical support, migration strategies, advice on best practices (and design decisions), PR reviews, and team augmentation. Read more about support here.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support from the amazing backers. If you'd like to join them, please read more here.

Principal Sponsors

Gold Sponsors

Silver Sponsors

Sponsors

Backers

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.