TimerTask interface

Paket:

durable-functions

Returneras från DurableClient.createTimer(Date) om anropet inte är yield-ed. Representerar en väntande timer. Mer information finns i dokumentationen om aktivitet.

Alla väntande timers måste slutföras eller avbrytas för att orkestreringen ska slutföras.

Exempel

Avbryt en timer

// calculate expiration date
const timeoutTask = context.df.createTimer(expirationDate);

// do some work

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}

Exempel

Skapa en timeout

const now = Date.now();
const expiration = new Date(now.valueOf()).setMinutes(now.getMinutes() + 30);

const timeoutTask = context.df.createTimer(expirationDate);
const otherTask = context.df.callActivity("DoWork");

const winner = yield context.df.Task.any([timeoutTask, otherTask]);

if (winner === otherTask) {
    // do some more work
}

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}

Extends

Task

Egenskaper

cancel	Anger att timern ska avbrytas. Den här begäran körs på nästa yield- eller return-instruktion.
isCanceled

Ärvda egenskaper

isCompleted	Om aktiviteten har slutförts. Observera att slutförandet inte motsvarar framgång.
isFaulted	Om uppgiften har felats på något sätt på grund av ett fel.
result	Resultatet av uppgiften, om den har slutförts. Annars undefined.

Egenskapsinformation

cancel

Anger att timern ska avbrytas. Den här begäran körs på nästa yield- eller return-instruktion.

cancel: () => void

Egenskapsvärde

() => void

isCanceled

isCanceled: boolean

Egenskapsvärde

boolean

Om timern har avbrutits eller inte.

Information om ärvda egenskaper

isCompleted

Om aktiviteten har slutförts. Observera att slutförandet inte motsvarar framgång.

isCompleted: boolean

Egenskapsvärde

boolean

ärvs fråntask.isCompleted

isFaulted

Om uppgiften har felats på något sätt på grund av ett fel.

isFaulted: boolean

Egenskapsvärde

boolean

ärvs fråntask.isFaulted

result

Resultatet av uppgiften, om den har slutförts. Annars undefined.

result?: unknown

Egenskapsvärde

unknown

ärvs frånTask.result