Class AsyncLock

Provides a simple way of creating the rough equivalent of an async critical section.

Example

const myLock = new AsyncLock();

private async MyFuncAsync(): Promise<void> {
  await myLock.lockAsync(async () => {
    await operation1Async();
    await operation2Async();
  });
}

Index

Constructors

constructor

Methods

lockAsync LockAsync

Constructors

constructor

new AsyncLock(): AsyncLock

Returns AsyncLock

Methods

lockAsync

lockAsync<T>(func: () => T | Promise<T>, signal?: AbortSignal): Promise<T>
Executes the provided function when the lock is acquired (e.g. when the previous operation finishes).
Type Parameters
- T
Parameters
- func: () => T | Promise<T>
  The function to execute.
- Optionalsignal: AbortSignal
  An optional signal that can be used to abort the operation.
Returns Promise<T>
A promise that resolves when the func finishes executing.
- Defined in packages/dev/core/src/Misc/asyncLock.ts:28

`Static`LockAsync

LockAsync<T>(
    func: () => T | Promise<T>,
    locks: AsyncLock[],
    signal?: AbortSignal,
): Promise<T>
Executes the provided function when all the specified locks are acquired.
Type Parameters
- T
Parameters
- func: () => T | Promise<T>
  The function to execute.
- locks: AsyncLock[]
  The locks to acquire.
- Optionalsignal: AbortSignal
  An optional signal that can be used to abort the operation.
Returns Promise<T>
A promise that resolves when the func finishes executing.
- Defined in packages/dev/core/src/Misc/asyncLock.ts:56

Class AsyncLock

Example

Index

Constructors

Methods

Constructors

constructor

Returns AsyncLock

Methods

lockAsync

Type Parameters

Parameters

Returns Promise<T>

StaticLockAsync

Type Parameters

Parameters

Returns Promise<T>

`Static`LockAsync