@nestjs/microservices

What is @nestjs/microservices?

@nestjs/microservices is a package for building microservice-based applications using the NestJS framework. It provides a set of tools and abstractions to create and manage microservices, allowing for communication between different parts of an application through various transport layers such as TCP, Redis, NATS, MQTT, and more.

What are @nestjs/microservices's main functionalities?

TCP Transport

This feature allows you to create a microservice that communicates over TCP. The code sample demonstrates how to set up a TCP microservice using NestFactory.

const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.TCP, options: { host: '127.0.0.1', port: 8877 } }); app.listen(() => console.log('Microservice is listening'));

Redis Transport

This feature allows you to create a microservice that communicates over Redis. The code sample shows how to set up a Redis microservice using NestFactory.

const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.REDIS, options: { url: 'redis://localhost:6379' } }); app.listen(() => console.log('Microservice is listening'));

NATS Transport

This feature allows you to create a microservice that communicates over NATS. The code sample demonstrates how to set up a NATS microservice using NestFactory.

const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.NATS, options: { url: 'nats://localhost:4222' } }); app.listen(() => console.log('Microservice is listening'));

MQTT Transport

This feature allows you to create a microservice that communicates over MQTT. The code sample shows how to set up an MQTT microservice using NestFactory.

const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.MQTT, options: { url: 'mqtt://localhost:1883' } }); app.listen(() => console.log('Microservice is listening'));

gRPC Transport

This feature allows you to create a microservice that communicates over gRPC. The code sample demonstrates how to set up a gRPC microservice using NestFactory.

const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.GRPC, options: { package: 'hero', protoPath: join(__dirname, './hero.proto') } }); app.listen(() => console.log('Microservice is listening'));

Other packages similar to @nestjs/microservices

micro

Micro is a framework for creating microservices in Node.js. It focuses on simplicity and minimalism, providing a lightweight solution for building microservices. Compared to @nestjs/microservices, Micro is less opinionated and does not provide as many built-in transport layers or integrations.

seneca

Seneca is a microservices toolkit for Node.js. It provides a way to organize business logic into microservices and supports various transport mechanisms. Seneca is more flexible in terms of plugin architecture but may require more configuration compared to @nestjs/microservices.

moleculer

Moleculer is a fast and powerful microservices framework for Node.js. It offers a wide range of features, including service discovery, load balancing, and fault tolerance. Moleculer provides more built-in features for microservice orchestration compared to @nestjs/microservices.

README

A progressive Node.js framework for building efficient and scalable web applications.

Description

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

Under the hood, Nest makes use of Express, 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.

Features

• Built with TypeScript (compatible with pure JavaScript + Babel)
• Easy to learn - syntax similar to Angular
• Familiar - based on well-known libraries (Express / socket.io)
• Dependency Injection - built-in asynchronous IoC container with a hierarchical injector
• WebSockets module (based on socket.io, but you can bring your own library, by making use of WsAdapter)
• Modular - defines an easy to follow module definition pattern so you can split your system into reusable modules
• Reactive microservice support with message patterns (built-in transport via TCP / Redis, but other communication schemes can be implemented with CustomTransportStrategy)
• Exception layer - throwable web exceptions with status codes, exception filters
• Pipes - synchronous & asynchronous (e.g. validation purposes)
• Guards - attach additional logic in a declarative manner (e.g. role-based access control)
• Interceptors - built on top of RxJS
• Testing utilities (both e2e & unit tests)

Installation

Install the TypeScript Starter Project with Git:

$ git clone https://github.com/nestjs/typescript-starter.git project
$ cd project
$ npm install
$ npm run start

Install the JavaScript (Babel) Starter Project with Git:

$ git clone https://github.com/nestjs/javascript-starter.git project
$ cd project
$ npm install
$ npm run start

Start a New Project from Scratch with NPM:

$ npm i --save @nestjs/core @nestjs/common @nestjs/microservices @nestjs/websockets @nestjs/testing reflect-metadata rxjs

Documentation & Quick Start

Documentation & Tutorial

People

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

Backers

I am on a mission to provide an architecture to create truly flexible, scalable and loosely coupled systems using the Node.js platform. It takes a lot of time, so if you want to support me, please become a backer / sponsor. I appreciate your help. Thanks!

License

MIT