π | .travis.yml |
π | LICENSE |
π | README.md |
π | index.js |
π | package.json |
π | tests |
README.md
SYNOPSIS
Creates a map of locks to ids that can be used as a semaphore
INSTALL
npm install <name>
USAGE
const LockMap = require('lockmap')
const lockmap = new LockMap()
const id = 'test'
// set a lock for an id
const unlock = lockmap.lock(id)
setTimeout(() => {
// do some async work
console.log('here first!')
unlock()
}, 300)
// wait until the lock resolves
await lockmap.getLock(id)
console.log('here now!')
API
getLock
gets the current lock if any for a given id. If there is a lock this will return a promise that resolves once the lock is unlocked return {Promise}
Parameters
id
lock
Creates a lock on a given ID and returns a resolve function to unlock the lock
Parameters
id
Any
Returns function the resolve function to call once it to unlock
LICENSE
Built with git-ssb-web