elock
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

node-elock

Greenkeeper badge

Easy use distributed redis lock implementation

Installation

npm install elock --save

Usage

// Init redis client
const Redis = require('ioredis');
const redisClient = new Redis();
 
// Init ELock
const ELock = require('elock');
const lock = new ELock({ redis: redisClient });
 
// Acquire Lock
lock.acquire('key').then(() => {
  // do someting when get lock
 
  // release after done
  return lock.release('key')
}).catch((err) => {
  // err when can't get lock
})
 
// Get lock
lock.get('key').then((res) => {
  if(res === null) return '' // null is get lock fail
  // do someting when get lock
})
 
// Check is Locked
lock.locked('key').then((locked) => {
  // locked is a boolean
})

Readme

Keywords

Package Sidebar

Install

npm i elock

Weekly Downloads

15

Version

1.2.0

License

MIT

Unpacked Size

7.41 kB

Total Files

5

Last publish

Collaborators

  • yourtion