Class RwLock<TRead, TWrite>

Ensure you have exclusive access in concurrent code

Only guaranteed if no one else has reference to the inner object

It can take a second type parameter to specify interface with write methods

Type Parameters

TRead
TWrite extends TRead = TRead

Index

Constructors

Properties

Methods

scopedRead scopedWrite

Constructors

constructor

new RwLock<TRead, TWrite = TRead>(t: TWrite): RwLock<TWrite>
Type Parameters
- TRead
- TWrite = TRead
Parameters
- t: TWrite
Returns RwLock<TWrite>
- Defined in sync/RwLock.ts:22

Properties

inner

inner: TWrite

This is public so inner object can be accessed directly ONLY SAFE in sync context

Methods

scopedRead

scopedRead<R>(fn: (t: TRead) => Promise<R>): Promise<R>
Acquire a read (shared) lock and call fn with the value. Release the lock when fn returns or throws.
Type Parameters
- R
Parameters
- fn: (t: TRead) => Promise<R>
Returns Promise<R>
- Defined in sync/RwLock.ts:27

scopedWrite

scopedWrite<R>(
fn: (t: TWrite, setter: (t: TWrite) => TWrite) => Promise<R>,
): Promise<R>
Acquire a write (exclusive) lock and call fn with the value. Release the lock when fn returns or throws.

fn takes a setter function as second parameter, which you can use to update the value like x = set(newX)
Type Parameters
- R
Parameters
- fn: (t: TWrite, setter: (t: TWrite) => TWrite) => Promise<R>
Returns Promise<R>
- Defined in sync/RwLock.ts:64