Redis transport in NestJS - Mini Project: Build & Apply

NestJS Redis Transport Setup

📖 Scenario: You are building a simple NestJS microservice that communicates using Redis as the transport layer. Redis will help your microservice send and receive messages efficiently.

🎯 Goal: Create a NestJS microservice that uses Redis transport. You will set up the Redis client, configure the microservice options, and start the microservice to listen for messages.

📋 What You'll Learn

Create a Redis client options object with the correct Redis URL

Create a microservice options object using Redis transport and the Redis client options

Use the NestFactory to create a microservice with the Redis options

Start the microservice to listen for incoming messages

💡 Why This Matters

🌍 Real World

Redis transport is used in microservices to enable fast, scalable communication between services in real-world applications like chat apps, notifications, and data processing pipelines.

💼 Career

Understanding Redis transport in NestJS is valuable for backend developers working on microservices architecture, improving system scalability and performance.

1

Create Redis client options

Create a constant called redisClientOptions and set it to an object with a url property equal to 'redis://localhost:6379'.

NestJS

# Your code here

Need a hint?

Use const redisClientOptions = { url: 'redis://localhost:6379' }; to set the Redis URL.

2

Create microservice options with Redis transport

Create a constant called microserviceOptions and set it to an object with transport set to Transport.REDIS and options set to redisClientOptions.

NestJS

const redisClientOptions = { url: 'redis://localhost:6379' };
# Your code here

Need a hint?

Use const microserviceOptions = { transport: Transport.REDIS, options: redisClientOptions }; to configure Redis transport.

3

Create the NestJS microservice

Use NestFactory.createMicroservice with AppModule and microserviceOptions. Assign the result to a constant called app. Import Transport from @nestjs/microservices and AppModule from ./app.module.

NestJS

import { NestFactory } from '@nestjs/core';
import { Transport } from '@nestjs/microservices';
import { AppModule } from './app.module';

const redisClientOptions = { url: 'redis://localhost:6379' };

const microserviceOptions = { transport: Transport.REDIS, options: redisClientOptions };

# Your code here

Need a hint?

Use const app = await NestFactory.createMicroservice(AppModule, microserviceOptions); inside an async function.

4

Start the microservice

Inside the bootstrap async function, call await app.listen() to start the microservice.

NestJS

import { NestFactory } from '@nestjs/core';
import { Transport } from '@nestjs/microservices';
import { AppModule } from './app.module';

const redisClientOptions = { url: 'redis://localhost:6379' };

const microserviceOptions = { transport: Transport.REDIS, options: redisClientOptions };

async function bootstrap() {
  const app = await NestFactory.createMicroservice(AppModule, microserviceOptions);
  # Your code here
}

bootstrap();

Need a hint?

Call await app.listen(); to start the microservice.