Mutex.lock() method
acquire lock
Signature:
lock(timeout?: number): Promise<MutexGuard<V>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| timeout | number |
Returns:
Promise<MutexGuard<V>>
MutexGuard - a function to release the lock, you can access wrapped value using MutexGuard.value before release
Example
const mutex = new Mutex({ a: 1 })
const { release, value } = await mutex.lock()
const ref = value
ref.a // => 1
release()
ref.a // => TypeError, temporary reference destroyed