R
C

SyncMutex

v0.0.5tested

A simple synchronous mutex to provide more readable locking and unlocking of code blocks

Example

ts
const mutex = new SyncMutex();

mutex.lock();

mutex.unlock();

const result = await mutex.execute(() => {
 // do something
 return Promise.resolve('done');
});

Signature

ts
class SyncMutex

Properties

PropertyTypeDescription
isLockedreadonlyboolean

Methods

lock
ts
public lock()
unlock
ts
public unlock()
execute
ts
public async execute<T>(callback: () => T)
ParameterTypeDescription
callback() => T
ReturnsPromise<T | undefined>