Interface Mortice

interface Mortice {
    queue?: Queue<unknown, AbortOptions>;
    finalize(): void;
    readLock(options?: AbortOptions): Promise<Release>;
    writeLock(options?: AbortOptions): Promise<Release>;
}

Index

Properties

Methods

finalize readLock writeLock

Properties

`Optional`queue

queue?: Queue<unknown, AbortOptions>

If this is the main thread, the state of the read/write queue may be inspected here

Methods

finalize

finalize(): void
Removes this mutex from the global state, after invoking this method it cannot be used any more.

Returns void
- Defined in index.ts:168

readLock

readLock(options?: AbortOptions): Promise<Release>
Acquire a read lock. Multiple reads will occur simultaneously up to the concurrency limit passed to the constructor.
Parameters
- Optionaloptions: AbortOptions
Returns Promise<Release>
- Defined in index.ts:155

writeLock

writeLock(options?: AbortOptions): Promise<Release>
Acquire a write lock. The write lock will wait for any in-flight reads to complete, then prevent any further reads or writes until the lock is released.
Parameters
- Optionaloptions: AbortOptions
Returns Promise<Release>
- Defined in index.ts:162