Planifier un rappel

Le fournisseur Scheduler vous permet de planifier une route sur votre application pour qu'elle soit appelée dans le futur après un temps spécifié, ou de manière répétée sur un intervalle.

Signature de la méthode

startAt(params: startAtParams)

Les types

Cette fonction prend des paramètres pour configurer le rappel programmé :

  • startAt(Chaîne) - La date de début du rappel programmé au format ISO.
  • callback: (Chaîne) - L'itinéraire à appeler.
  • id: (Chaîne optionnelle) - Identifiant du rappel programmé, s'il n'est pas fourni, un rappel sera généré. A utiliser pour annuler un planificateur après sa création.
  • interval(Facultatif) : (Facultatif) IntervalParams) - S'il est spécifié, le rappel programmé sera répété à cet intervalle.
  • payload: (Objet facultatif) - Données facultatives à envoyer au rappel.

IntervalParams:

  • cron: (Chaîne) - Utiliser un CRON pour programmer la fréquence d'appel de l'itinéraire.
  • until: (UntilParams) - Arrêter l'ordonnanceur après une durée déterminée.

UntilParams:

  • date: (Chaîne) - Une date au format ISO.
  • maxInvocations: (Int) - Le nombre maximum de fois que le programmateur doit s'exécuter.

Programmation d'un rappel

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!',
    },
});