Minimum lock

This package provides a bare minimum tool for "locking" resources.

How to use it?

Installation

You can install the library into your project via npm:

1npm install minimum-lock

This package does not have any dependencies.

Usage

Again, this tool is bare minimum, it does not provide any fancy interface, just a class to create an object which can be locked and released.

1import { Lock } from 'minimum-lock';
2
3async function doSomethingWithLock(lock) {
4  const release = await lock.acquire();
5  
6  doSomethingMustBeSequential();
7  
8  release();
9}
10
11async function doSomething() {
12  ...
13  
14  const lock = new Lock();
15  
16  doSomethingWithLock(lock);
17  doSomethingWithLock(lock);
18}

⚠️ The acquire method returns a release callback, if you forget to call this release callback, the lock is locked forever.