Delen via


CancellableAsyncLock interface

CancellableAsyncLock biedt een mechanisme om af te dwingen dat taken met dezelfde 'sleutel' serieel worden uitgevoerd.

Taken in behandeling kunnen handmatig worden geannuleerd via een abortSignal of automatisch worden geannuleerd door een opgegeven time-outwaarde te bereiken.

Methoden

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

Retourneert een belofte die wordt omgezet in de waarde die wordt geretourneerd door de opgegeven taakfunctie. Er kan slechts één taak tegelijk worden aangeroepen voor een bepaalde key waarde.

Een acquire-aanroep kan worden geannuleerd via een abortSignal. Als deze wordt geannuleerd, wordt de belofte geweigerd met een AbortError.

acquireTimeoutInMs kan ook worden opgegeven aan eigenschappen. Als de time-out is bereikt voordat de opgegeven task wordt aangeroepen, wordt de belofte geweigerd met een fout die aangeeft dat er een time-out is opgetreden voor de taak in afwachting van een vergrendeling.

Methodedetails

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

Retourneert een belofte die wordt omgezet in de waarde die wordt geretourneerd door de opgegeven taakfunctie. Er kan slechts één taak tegelijk worden aangeroepen voor een bepaalde key waarde.

Een acquire-aanroep kan worden geannuleerd via een abortSignal. Als deze wordt geannuleerd, wordt de belofte geweigerd met een AbortError.

acquireTimeoutInMs kan ook worden opgegeven aan eigenschappen. Als de time-out is bereikt voordat de opgegeven task wordt aangeroepen, wordt de belofte geweigerd met een fout die aangeeft dat er een time-out is opgetreden voor de taak in afwachting van een vergrendeling.

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

Parameters

key

string

Alle acquire aanroepen worden gegroepeerd op de opgegeven key.

task

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

De functie die moet worden aangeroepen zodra de vergrendeling is verkregen.

properties
AcquireLockProperties

Aanvullende eigenschappen voor het beheren van het gedrag van acquire.

Retouren

Promise<T>