Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martinheidegger/flexlock
A memory-efficient, in-memory, flexible, Promise-based locking library without dependencies.
https://github.com/martinheidegger/flexlock
javascript lock multithreading mutex mutex-lock mutex-synchronisation process
Last synced: 2 months ago
JSON representation
A memory-efficient, in-memory, flexible, Promise-based locking library without dependencies.
- Host: GitHub
- URL: https://github.com/martinheidegger/flexlock
- Owner: martinheidegger
- License: mit
- Created: 2018-02-05T15:58:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-26T04:14:00.000Z (over 5 years ago)
- Last Synced: 2024-10-10T12:51:39.216Z (2 months ago)
- Topics: javascript, lock, multithreading, mutex, mutex-lock, mutex-synchronisation, process
- Language: JavaScript
- Homepage:
- Size: 174 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# flexlock
[](https://standardjs.com)
[](https://codeclimate.com/github/martinheidegger/flexlock/maintainability)
[](https://codeclimate.com/github/martinheidegger/flexlock/test_coverage)
`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`](https://github.com/mafintosh/mutexify), [`mutex-js`](https://github.com/danielglennross/mutex-js), [`await-lock`](https://www.npmjs.com/package/await-lock), and [many more](https://www.npmjs.com/search?q=promise+lock), but with more flexibility in how
to use it. This makes it sturdier and more practical in many cases.
### _simple_ API when that suffices
```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
})
```
### _Timeouts_ in case anther lock never returns
```javascript
lock(() => new Promise()) // This never releases the lock
lock(async () => {}, 500)
.catch(err => {
err.code === 'ETIMEOUT'
})
```
### _Propagation_ of errors and results
```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!
}
}
```
### _Dedicated locks_ for more readable async code
```javascript
async function business () {
const unlock = await lock()
// do your thing
unlock()
}
```
### _release_ handlers both once and globally
```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
```
### _Namespace_ support for multiple lockers
```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._
### License
MIT