A mutex/semaphore implementation made easy to use.
Why
superlock aims to be:
- Simple: Designed for usage with
asyncandawait - Powerful: Mutex & Semaphore patterns supported
- Secure: Auto lock release toa void dead locks
- Lightweight: No dependencies, just ~50 LOC
- Well-tested: 100% code coverage
Install
$ npm install superlock --save
Usage
as mutex
The lock is a mutex by default:
const { withLock } = require('superlock')
const delay = require('delay')
const lock = withLock()
const executions = await Promise.all(
[...Array(10).keys()].map(index =>
lock(async () => {
await delay(Math.random() * 100)
return index
})
)
)
console.log(executions)
as semaphore
Just call withLock(n) being n the maximum of concurrency desired for the lock.
API
withLock([concurrency=1])
It returns a function that can be used to wrap any code you want to execute with concurrency control:
const { withLock } = require('superlock')
const lock = createLock()
await lock(() => {
/* your code execution */
})
The lock will be automatically released after your code execution is done even if an error occurred, avoiding deadlock situations.
concurrency
Type: number
Default: 1
It sets the maximum of concurrency allowed for the lock.
.isLocked()
Type: boolean
It returns false if there is at least one free concurrency slots in the lock.
License
superlock © Kiko Beats, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.
kikobeats.com · GitHub Kiko Beats · Twitter @Kikobeats
2 Jan 18, 2022
16 Aug 29, 2022
7 Jun 25, 2022
9 Aug 29, 2022
4 Oct 14, 2022
0 Dec 23, 2021
13k Jan 2, 2023
24 Jun 28, 2022
34 Dec 20, 2022
7 Sep 10, 2022