TimerTask interface

Pacote:

durable-functions

Retornado de DurableClient.createTimer(Date) se a chamada não estiver yield-ed. Representa um temporizador pendente. Consulte a documentação em de Tarefas para obter mais informações.

Todos os temporizadores pendentes devem ser concluídos ou cancelados para que uma orquestração seja concluída.

Exemplo

Cancelar um temporizador

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

Exemplo

Criar um tempo limite

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

Propriedades

cancel	Indica que o temporizador deve ser cancelado. Essa solicitação será executada na próxima yield ou return declaração.
isCanceled

Propriedades Herdadas

isCompleted	Se a tarefa foi concluída. Note que a conclusão não é equivalente ao sucesso.
isFaulted	Se a tarefa falhou de alguma forma devido a erro.
result	O resultado da tarefa, se concluída. Caso contrário, undefined.

Detalhes de Propriedade

cancel

Indica que o temporizador deve ser cancelado. Essa solicitação será executada na próxima yield ou return declaração.

cancel: () => void

Valor de Propriedade

() => void

isCanceled

isCanceled: boolean

Valor de Propriedade

boolean

Se o temporizador foi ou não cancelado.

Detalhes da Propriedade Herdada

isCompleted

Se a tarefa foi concluída. Note que a conclusão não é equivalente ao sucesso.

isCompleted: boolean

Valor de Propriedade

boolean

herdado de Task.isCompleted

isFaulted

Se a tarefa falhou de alguma forma devido a erro.

isFaulted: boolean

Valor de Propriedade

boolean

herdado de Task.isFaulted

result

O resultado da tarefa, se concluída. Caso contrário, undefined.

result?: unknown

Valor de Propriedade

unknown

herdado de Task.result