Freigeben über


CancellableAsyncLock interface

CancellableAsyncLock bietet einen Mechanismus zum Erzwingen von Aufgaben mit demselben Schlüssel, der serial ausgeführt werden soll.

Ausstehende Vorgänge können über ein "abortSignal" manuell abgebrochen oder automatisch abgebrochen werden, indem ein bereitgestellter Timeoutwert erreicht wird.

Methoden

acquire<T>(string, (args: any[]) => Promise<T>, AcquireLockProperties)

Gibt eine Zusage zurück, die in den von der bereitgestellten Aufgabenfunktion zurückgegebenen Wert aufgelöst wird. Für einen bestimmten key Wert kann jeweils nur eine Aufgabe aufgerufen werden.

Ein Kaufanruf kann über eine abortSignalabgebrochen werden. Wenn dies abgebrochen wird, wird die Zusage mit einem AbortErrorabgelehnt.

acquireTimeoutInMs können auch Eigenschaften bereitgestellt werden. Wenn das Timeout erreicht ist, bevor die bereitgestellte task aufgerufen wird, wird die Zusage mit einem Fehler abgelehnt, der angibt, dass der Vorgang timeout warte, bis eine Sperre abgerufen wurde.

Details zur Methode

acquire<T>(string, (args: any[]) => Promise<T>, AcquireLockProperties)

Gibt eine Zusage zurück, die in den von der bereitgestellten Aufgabenfunktion zurückgegebenen Wert aufgelöst wird. Für einen bestimmten key Wert kann jeweils nur eine Aufgabe aufgerufen werden.

Ein Kaufanruf kann über eine abortSignalabgebrochen werden. Wenn dies abgebrochen wird, wird die Zusage mit einem AbortErrorabgelehnt.

acquireTimeoutInMs können auch Eigenschaften bereitgestellt werden. Wenn das Timeout erreicht ist, bevor die bereitgestellte task aufgerufen wird, wird die Zusage mit einem Fehler abgelehnt, der angibt, dass der Vorgang timeout warte, bis eine Sperre abgerufen wurde.

function acquire<T>(key: string, task: (args: any[]) => Promise<T>, properties: AcquireLockProperties): Promise<T>

Parameter

key

string

Alle acquire Anrufe werden nach der bereitgestellten keygruppiert.

task

(args: any[]) => Promise<T>

Die Funktion, die aufgerufen werden soll, nachdem die Sperre abgerufen wurde.

properties
AcquireLockProperties

Zusätzliche Eigenschaften zum Steuern des Verhaltens von acquire.

Gibt zurück

Promise<T>