---

Features

- Redlock-based distributed locks
- Works with existing @nestjs-redis/client connections
- Decorator @Redlock() and RedlockService
- Type-safe, production-ready

Installation

``bash
npm install @nestjs-redis/lock @nestjs-redis/client redis
`

The recommended approach is to use RedisModule from @nestjs-redis/client so Redis connections are lifecycle-managed by Nest (connect/disconnect with your app). Alternatively, you can pass your own Redis client (e.g. created with createClient() from redis) and manage its lifecycle yourself.

Quick Start

`typescript
// app.module.ts
import { Module } from '@nestjs/common';
import { RedisModule, RedisToken } from '@nestjs-redis/client';
import { RedlockModule } from '@nestjs-redis/lock';

@Module({
imports: [
RedisModule.forRoot({ options: { url: 'redis://localhost:6379' } }),
RedlockModule.forRootAsync({
inject: [RedisToken()],
useFactory: (redis) => ({ clients: [redis] }),
}),
],
})
export class AppModule {}
`

$3

`typescript
import { Injectable } from '@nestjs/common';
import { Redlock } from '@nestjs-redis/lock';

@Injectable()
export class UserService {
@Redlock('user:update', 5000)
async updateUserBalance(userId: string, amount: number) {
// critical work
}
}
`

$3

`typescript
@Injectable()
export class PaymentService {
constructor(private readonly redlock: RedlockService) {}

async processPayment(paymentId: string) {
return this.redlock.withLock([payment:${paymentId}], 5000, async () => {
// critical work
});
}
}
``

Links

- Root repo: CSenshi/nestjs-redis
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Built on @redis-kit/lock: docs

Contributing

Please see the root contributing guidelines.

License

MIT © CSenshi