@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

Modern, powerful web application framework for Node.js.

Description

Nest is a powerful web framework for Node.js, which helps you effortlessly build efficient, scalable applications. It uses modern JavaScript, is built with TypeScript and combines best concepts of both OOP (Object Oriented Progamming) and FP (Functional Programming).

It is not just another framework. You do not have to wait for a large community, because Nest is built with awesome, popular well-known libraries - Express and socket.io! It means, that you could quickly start using framework without worrying about a third party plugins.

Installation

$ npm install nest.js

Philosophy

JavaScript is awesome. This language is no longer just a trash to create simple animations in the browser. Right now, the front end world is rich in variety of tools. We have a lot of amazing frameworks / libraries such as Angular, React or Vue, which improves our development process and makes our applications fast and flexible.

Node.js gave us a possibility to use this language also on the server side. There are a lot of superb libraries, helpers and tools for node, but non of them do not solve the main problem - the architecture.

We want to create scalable, modern and easy to maintain applications. Nest helps us with it.

Features

• Compatible with both TypeScript and ES6 (I strongly recommend to use TypeScript)
• Based on well-known libraries (Express / socket.io) so you could share your experience
• Easy to learn - syntax is similar to Angular / Spring (Java)
• Dependency Injection, built-in Inversion of Control container
• Exceptions handler layer (helps to focus on logic)
• Own modularity system (split your system into reusable modules)
• WebSockets module (based on socket.io)
• Reactive microservices support with messages patterns (transport via TCP / Redis)
• Testing utilities

Documentation & Quick Start

Documentation & Tutorial

Starter repos

• TypeScript
• Babel

Future

Nest is very much still a work in progress. There is still some things to finish:

• Examples(!)
• Validation helpers
• More test utilities
• and more...

People

Author - Kamil Myśliwiec

License

MIT