CancellableAsyncLock interface
CancellableAsyncLock は、同じ 'キー' を使用してタスクを強制的に実行するメカニズムを提供します。
保留中のタスクは、abortSignal を使用して手動で取り消すか、指定されたタイムアウト値に達すると自動的に取り消すことができます。
メソッド
| acquire<T>(string, (args: any[]) => Promise<T>, Acquire |
指定されたタスク関数によって返される値に解決される promise を返します。
特定 取得呼び出しは、 を
|
メソッドの詳細
acquire<T>(string, (args: any[]) => Promise<T>, AcquireLockProperties)
指定されたタスク関数によって返される値に解決される promise を返します。
特定 key の値に対して一度に呼び出すことができるタスクは 1 つだけです。
取得呼び出しは、 を abortSignal介して取り消すことができます。
取り消された場合、約束は で AbortError拒否されます。
acquireTimeoutInMs プロパティにも指定できます。
指定 task された が呼び出される前にタイムアウトに達した場合、タスクがロックの取得を待機してタイムアウトしたことを示すエラーが表示され、Promise は拒否されます。
function acquire<T>(key: string, task: (args: any[]) => Promise<T>, properties: AcquireLockProperties): Promise<T>パラメーター
- key
-
string
すべての acquire 呼び出しは、指定 keyされた によってグループ化されます。
- task
-
(args: any[]) => Promise<T>
ロックが取得された後に呼び出す関数。
- properties
- AcquireLockProperties
の動作を制御するための追加の acquireプロパティ。
戻り値
Promise<T>