TimerTask interface

Pakket:

durable-functions

Geretourneerd van DurableClient-.createTimer(Date) als de oproep niet is yield-ed. Vertegenwoordigt een timer die in behandeling is. Zie de documentatie over Taak voor meer informatie.

Alle timers die in behandeling zijn, moeten worden voltooid of geannuleerd om een indeling te voltooien.

voorbeeld van

Een timer annuleren

// 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();
}

voorbeeld van

Een time-out maken

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();
}

Uitbreiding

Task

Eigenschappen

cancel	Geeft aan dat de timer moet worden geannuleerd. Deze aanvraag wordt uitgevoerd op de volgende yield of return instructie.
isCanceled

Overgenomen eigenschappen

isCompleted	Of de taak is voltooid. Houd er rekening mee dat voltooiing niet gelijk is aan succes.
isFaulted	Of de taak een fout heeft veroorzaakt door een fout.
result	Het resultaat van de taak, indien voltooid. Anders undefined.

Eigenschapdetails

cancel

Geeft aan dat de timer moet worden geannuleerd. Deze aanvraag wordt uitgevoerd op de volgende yield of return instructie.

cancel: () => void

Waarde van eigenschap

() => void

isCanceled

isCanceled: boolean

Waarde van eigenschap

boolean

Of de timer al dan niet is geannuleerd.

Details van overgenomen eigenschap

isCompleted

Of de taak is voltooid. Houd er rekening mee dat voltooiing niet gelijk is aan succes.

isCompleted: boolean

Waarde van eigenschap

boolean

overgenomen vanTask.isCompleted

isFaulted

Of de taak een fout heeft veroorzaakt door een fout.

isFaulted: boolean

Waarde van eigenschap

boolean

overgenomen vanTask.isFaulted

result

Het resultaat van de taak, indien voltooid. Anders undefined.

result?: unknown

Waarde van eigenschap

unknown

overgenomen vanTask.result