flexlock


flexlock is a small, memory-concious, flexible, Promise-based locking library without dependencies.

npm i flexlock --save

It is similar to other in-memory locking library like mutexify, mutex-js, await-lock, and many more, but with more flexibility in how
to use it. This makes it sturdier and more practical in many cases.

$3

``javascript
const createLock = require('flexlock/createLock') // require('flexlock').createLock works too

const lock = createLock()

lock(async () => {
// done before the next block
})
lock(async () => {
// done after the previous block
})
`

$3

`javascript
lock(() => new Promise()) // This never releases the lock
lock(async () => {}, 500)
.catch(err => {
err.code === 'ETIMEOUT'
})
`

$3

`javascript
async function business () {
try {
const important = await lock(async () => {
// do your thing
return important
})
// You can use the important data here.
} catch (err) {
// Woops, something happened!
}
}
`

$3

`javascript
async function business () {
const unlock = await lock()
// do your thing
unlock()
}
`

$3

`javascript
const lock = createLock(() => {
// called every time the lock is released
})

lock.released(function () {
// called once, next time the lock is released
})

await lock.released() // Promise API available as well
`

$3

`javascript
const createLocker = require('flexlock/createLocker') // require('flexlock').createLocker works too

const lock = createLocker()

async function business (id, content) {
await lock(id, async () => {
// do your thing, locked to this id!
})
}
`

_Implementation note: The locker will use createLock` per id. It will keep the created lock until all locks
for that id are released. Then it will pass the lock to the garbage collector._

$3

MIT