Agendar um retorno de chamada

O provedor Scheduler permite que você programe uma rota em seu aplicativo para ser executada no futuro, após um determinado período, ou repetidamente em intervalos regulares.

Assinatura do método

startAt(params: startAtParams)

Tipos

Essa função recebe parâmetros para configurar o callback agendado:

• startAt: (String) - A data em que a chamada de retorno agendada deve começar, no formato ISO.
• callback: (String) - A rota a ser chamada.
• id: (String opcional) — Identificador para o callback agendado; caso não seja fornecido, um será gerado. Use-o para cancelar um agendador após sua criação.
• interval: (Opcional IntervalParams) - Se especificado, a chamada de retorno agendada se repetirá nesse intervalo.
• payload: (Objeto opcional) - Dados opcionais a serem enviados para a função de retorno de chamada.

IntervalParams:

• cron: (String) - Use um CRON expressão para definir a frequência com que a rota é chamada.
• until: (UntilParams) - Interromper o agendador após um tempo especificado.

UntilParams:

• date: (String) - Uma data no formato ISO.
• maxInvocations: (Int) - O número máximo de vezes que o agendador deve ser executado.

Agendamento de um retorno de chamada

const session = vcr.createSession();
const scheduler = new Scheduler(session);

await scheduler.startAt({
    id: 'myScheduler',
    startAt: new Date(Date.now() + 5000).toISOString(),
    callback: 'onScheduler',
    payload: {
        text: 'hello world!',
    },
});