Aller au contenu

onSource

Écoute ce que disent les sources d’événements : le chargement, une récupération échouée, des événements refusés, les enregistrements.

Type(n: SourceNotice) => void
Par défautnon défini
Modifiable en direct (update())Non — à la création seulement
Déclaré danspackages/core/src/kernel.ts

Elle reçoit un avis à la fois, selon son type :

  • loading ({ loading }) : vrai tant que quelque chose est récupéré — un indicateur de chargement.
  • error ({ sourceId, error }) : une récupération a échoué pour de bon, après ses nouvelles tentatives ; ce qui était montré reste.
  • problems ({ sourceId, report }) : des événements d’une livraison ont été refusés ou corrigés (report.problems, chacun { code, severity, path, detail }). Ceux de l’option events arrivent ici aussi quand ils se chargent plus tard (au-delà de 2 000 événements).
  • save-error ({ sourceId, edits, error, reverted }) et saved : le save d’une source refusé (reverted : les modifications remises ; ou, quand les événements ont changé entre-temps, la source récupérée de nouveau) ou fait.

Elle est lue à la création du calendrier. Une mauvaise donnée d’une source ne lève jamais d’exception : elle arrive ici (les problèmes d’un petit tableau events sont plutôt dans calendar.kernel.getProblems()).

import { jsonSource } from '@dzcalendar/core';
import { createCalendar } from '@dzcalendar/dom';
const spinner = document.getElementById('spinner')!;
createCalendar(element, {
timeZone: 'Europe/Paris',
sources: [jsonSource('appointments', { url: '/api/rendez-vous', retry: { attempts: 2, backoffMs: 500 } })],
onSource: (notice) => {
if (notice.type === 'loading') spinner.hidden = !notice.loading;
if (notice.type === 'error') console.error(`${notice.sourceId} could not be fetched`, notice.error);
if (notice.type === 'problems') console.warn(notice.report.problems);
},
});

Dans les frameworks, c’est une sortie : (sourceNotice) en Angular, onSourceNotice en React, @source-notice en Vue. Leurs contrôleurs gardent aussi loading et problems à lire.