Class RedisLockProvider

Redis-based distributed lock provider used by SessionKit refresh flows.

Implements

LockProvider

Index

Constructors

Methods

withLock close acquireLock

Properties

keyPrefix acquireTimeoutMs retryDelayMs clientManager ownsClientManager

Constructors

constructor

new RedisLockProvider(
input: RedisLockProviderInput,
options?: RedisLockProviderOptions,
): RedisLockProvider
Parameters
- input: RedisLockProviderInput
- Optionaloptions: RedisLockProviderOptions
Returns RedisLockProvider
- Defined in packages/redis/src/RedisLockProvider.ts:43

Methods

withLock

withLock<T>(key: string, ttlSeconds: number, fn: () => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- key: string
- ttlSeconds: number
- fn: () => Promise<T>
Returns Promise<T>
Implementation of LockProvider.withLock
- Defined in packages/redis/src/RedisLockProvider.ts:56

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/redis/src/RedisLockProvider.ts:99

`Private`acquireLock

acquireLock(
    client: RedisClientLike,
    lockKey: string,
    token: string,
    ttlSeconds: number,
): Promise<boolean>
Parameters
- client: RedisClientLike
- lockKey: string
- token: string
- ttlSeconds: number
Returns Promise<boolean>
- Defined in packages/redis/src/RedisLockProvider.ts:106

Properties

`Private` `Readonly`keyPrefix

keyPrefix: string

`Private` `Readonly`acquireTimeoutMs

acquireTimeoutMs: number

`Private` `Readonly`retryDelayMs

retryDelayMs: number

`Private` `Readonly`clientManager

clientManager: RedisClientManager

`Private` `Readonly`ownsClientManager

ownsClientManager: boolean