CacheModule setup in NestJS - Mini Project: Build & Apply

CacheModule setup

📖 Scenario: You are building a NestJS application that needs to store temporary data to speed up responses. You will set up the CacheModule to enable caching in your app.

🎯 Goal: Set up the CacheModule in a NestJS application to enable caching with a default time-to-live (TTL) of 5 seconds.

📋 What You'll Learn

Import CacheModule from '@nestjs/common'

Register CacheModule in the root module with a TTL of 5 seconds

Use the CacheModule in the AppModule imports array

💡 Why This Matters

🌍 Real World

Caching helps speed up web applications by storing data temporarily so it can be reused quickly without recalculating or fetching it again.

💼 Career

Many backend jobs require setting up caching to improve app performance and reduce server load, making this a valuable skill for NestJS developers.

1

Import CacheModule

Import CacheModule from '@nestjs/common' at the top of your app.module.ts file.

NestJS

// Import CacheModule from '@nestjs/common'
// Your code here

Need a hint?

Use the import statement to bring CacheModule from '@nestjs/common'.

2

Register CacheModule with TTL

Inside the @Module decorator, add CacheModule.register({ ttl: 5 }) to the imports array in AppModule.

NestJS

import { Module, CacheModule } from '@nestjs/common';

@Module({
  imports: [
    // Register CacheModule with ttl 5 seconds here
  ],
})
export class AppModule {}

Need a hint?

Use CacheModule.register with an object setting ttl to 5 inside the imports array.

3

Add a simple service to use cache

Create a service class called AppService with a method getHello() that returns the string 'Hello World!'. Add AppService to the providers array in AppModule.

NestJS

import { Module, CacheModule } from '@nestjs/common';

@Module({
  imports: [
    CacheModule.register({ ttl: 5 }),
  ],
  providers: [
    // Add AppService provider here
  ],
})
export class AppModule {}

// Create AppService class below
// Your code here

Need a hint?

Define AppService with a getHello() method returning 'Hello World!'. Add it to providers.

4

Use CacheInterceptor globally

Import CacheInterceptor and APP_INTERCEPTOR from '@nestjs/common'. Add a provider to AppModule that sets provide: APP_INTERCEPTOR and useClass: CacheInterceptor to enable caching globally.

NestJS

import { Module, CacheModule, CacheInterceptor, APP_INTERCEPTOR } from '@nestjs/common';

@Module({
  imports: [
    CacheModule.register({ ttl: 5 }),
  ],
  providers: [
    AppService,
    // Add global cache interceptor provider here
  ],
})
export class AppModule {}

export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

Need a hint?

Use APP_INTERCEPTOR token with CacheInterceptor in providers to enable global caching.