API

const { data, error, isLoading, isValidating, mutate } = useSWR(key, fetcher, options)

Paramètres

• key: une chaîne de caractères unique pour la requête (ou une fonction / tableau / null) (détails), (utilisation avancée)
• fetcher: (facultatif) une fonction retournant une promesse pour récupérer vos données (détails)
• options: (facultatif) un objet d'options pour ce hook SWR

Valeurs retournées

• data: données pour la clé donnée résolue par fetcher (ou undefined si non chargé)
• error: erreur renvoyée par fetcher (ou undefined)
• isLoading: si une requête est en cours et qu'aucune "donnée chargée" n'est disponible. Les données de secours et les données précédentes ne sont pas considérées comme des "données chargées"
• isValidating: s'il y a une requête ou une revalidation en cours de chargement
• mutate(data?, options?): fonction pour muter la donnée mise en cache (détails)

Plus d'informations ici.

Options

• suspense = false: activer le mode React Suspense (détails)
• fetcher(args): la fonction fetcher
• revalidateIfStale = true: revalider automatiquement même s'il y a des données obsolètes (détails)
• revalidateOnMount: activer ou désactiver la revalidation automatique lorsque le composant est monté
• revalidateOnFocus = true: revalider automatiquement lorsque la fenêtre est mise au premier plan (détails)
• revalidateOnReconnect = true: revalider automatiquement lorsque le navigateur retrouve une connexion réseau (via navigator.onLine) (détails)
• refreshInterval (détails):
  • Désactivé par défaut: refreshInterval = 0
  • Si défini sur un nombre, intervalle de sondage en millisecondes
  • Si défini sur une fonction, la fonction recevra les dernières données et devrait renvoyer l'intervalle en millisecondes
• refreshWhenHidden = false: actualisation lorsque la fenêtre est invisible (si refreshInterval est activé)
• refreshWhenOffline = false: actualisation lorsque le navigateur est hors ligne (déterminé par navigator.onLine)
• shouldRetryOnError = true: réessayer lorsque le fetcher a une erreur
• dedupingInterval = 2000: dédupliquer les requêtes avec la même clé dans cette période de temps en millisecondes
• focusThrottleInterval = 5000: ne revalider qu'une seule fois pendant une période de temps en millisecondes
• loadingTimeout = 3000: délai d'attente pour déclencher l'événement onLoadingSlow en millisecondes
• errorRetryInterval = 5000: intervalle avant la nouvelle tentative en millisecondes
• errorRetryCount: nombre maximal de tentatives d'erreur
• fallback: un objet clé-valeur de plusieurs données de secours (exemple)
• fallbackData: données initiales à renvoyer (note : ceci est per-hook)
• keepPreviousData = false: renvoyer les données de la clé précédente jusqu'à ce que les nouvelles données soient chargées (détails)
• onLoadingSlow(key, config): fonction de rappel lorsqu'une requête prend trop de temps à charger (voir loadingTimeout)
• onSuccess(data, key, config): fonction de rappel lorsqu'une requête se termine avec succès
• onError(err, key, config): fonction de rappel lorsqu'une requête renvoie une erreur
• onErrorRetry(err, key, config, revalidate, revalidateOps): gestionnaire des nouvelles tentatives d'erreur
• onDiscarded(key): fonction de rappel lorsqu'une requête est ignorée en raison de conditions de course
• compare(a, b): fonction de comparaison utilisée pour détecter quand les données renvoyées ont changé, pour éviter les rendus superflus. Par défaut, stable-hash est utilisé.
• isPaused(): fonction pour détecter si les revalidations sont en pause, ignorera les données récupérées et les erreurs lorsqu'elle renvoie true. Renvoie false par défaut.
• use: tableau de fonctions middleware (détails)

Vous pouvez également utiliser la configuration globale pour fournir des options par défaut.