Skip to content

Commit b8e8f83

Browse files
committed
fix: update documentation for RedisConnection class to clarify its purpose and functionality
1 parent 32ef8fb commit b8e8f83

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

packages/idempotency/src/persistence/RedisConnection.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ import type { RedisClientType, RedisClusterType } from '@redis/client';
33
import type { RedisConnectionConfig } from '../types/RedisPersistence.js';
44

55
/**
6-
* RedisConnection class is responsible for creating a Redis client based on the provided configuration.
7-
* It supports both standalone and cluster modes.
8-
* The class takes a configuration object as a parameter and initializes the Redis client accordingly.
6+
* A class for creating and managing Redis client connections.
7+
*
8+
* This class handles both standalone and cluster connection modes to Redis,
9+
* providing an abstraction layer over the Redis client creation process.
910
*/
1011
class RedisConnection {
1112
readonly #mode: 'standalone' | 'cluster';

0 commit comments

Comments
 (0)