@microfleet/ioredis-lock
Version:
Node distributed locking using redis with ioredis adapter
25 lines (20 loc) • 585 B
text/typescript
/**
* redislock exposes a total of two functions: createLock,
* and getActiveLocks.
*/
import { Lock, type Config } from './lock.js'
export * from './errors.js'
export { Config, type Lock }
/**
* Returns a new Lock instance, configured for use with the supplied redis
* client, as well as options, if provided.
*/
export function createLock(...args: ConstructorParameters<typeof Lock>): Lock {
return new Lock(...args)
}
/**
* Returns an array of currently active/acquired locks.
*/
export function getAcquiredLocks(): Lock[] {
return Array.from(Lock._acquiredLocks)
}