Skip to content

@sylis/api v0.0.1


@sylis/api / modules/redis/distributed-lock.decorator / DistributedLockDecoratorOptions

Interface: DistributedLockDecoratorOptions

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:8

Properties

cacheExpireSeconds?

optional cacheExpireSeconds: number

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:20

缓存过期时间(秒),默认 300 秒


expireSeconds?

optional expireSeconds: number

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:12

锁的过期时间(秒),默认 30 秒


keyGenerator()?

optional keyGenerator: (...args) => string

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:22

自定义key生成函数,接收方法参数并返回key的一部分

Parameters

args

...any[]

Returns

string


prefix

prefix: string

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:10

锁的前缀,用于生成锁的key


retryIntervalMs?

optional retryIntervalMs: number

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:16

轮询间隔(毫秒),默认 100ms


timeoutMs?

optional timeoutMs: number

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:14

获取锁的超时时间(毫秒),默认 5000ms


useCache?

optional useCache: boolean

Defined in: apps/api/src/modules/redis/distributed-lock.decorator.ts:18

是否启用缓存模式,默认 false