Skip to main content
Les Hook vous permettent de capturer des événements externes. Vous pouvez créer des Hooks pour les événements Twitch ou d’autre integration disponible. Lorsqu’un événement se produit, Sparkle exécute la callback associée, vous permettant de traiter l’événement.

​
Création d’un Hook

Pour créer un Hook, vous devez utiliser la fonction createHook. Cette fonction attend un objet de configuration avec les propriétés suivantes :
Paramètres
eventrequisIdentifiant de l’événement
filteroptionnelUne fonction de filtrage pour décider si l’événement doit être traité
callbackrequisLa fonction de rappel à exécuter lorsque l’événement se produit
export default createHook({
  event: "channel.update",
  run: async (event, ctx) => {
    // Traitement de l'événement ici
  },
})
Dans cet exemple, nous créons un Hook pour l’événement “channel.update” de Twitch. Lorsque cet événement se produit, la fonction de rappel (callback) est exécutée, vous permettant de traiter l’événement.

​
Filtrage d’événements

La fonction createHook prend en charge un paramètre optionnel pour filtrer les événements avant leur exécution. Vous pouvez spécifier une fonction de filtrage qui décide si l’événement doit être traité ou ignoré. Voici comment vous pouvez utiliser ce paramètre de filtrage : 
export default createHook({
  event: "channel.subscribe",
  filter: (event) => {
    // On ne traite que les événements de tier 3
    return event.tier === "3000"
  },
  run: async (event, ctx) => {
    // Votre logique de traitement de l'événement ici
  },
})
Dans cet exemple, le paramètre de filtrage décide si l’événement doit être traité en fonction de la condition spécifiée dans l’événement. Vous pouvez personnaliser la logique de filtrage en fonction de vos besoins.

​
Événements Twitch Disponibles

Retrouvez tout les événements Twitch disponible sur la page Événements Twitch.

​
Utilisation des Hooks

Une fois que vous avez créé un Hook pour un événement spécifique, il sera automatiquement activé pour capturer cet événement dès qu’il se produit. Vous pouvez utiliser des Hooks pour réagir en temps réel aux événements externes et déclencher des actions spécifiques dans votre application. N’oubliez pas de consulter la documentation complète de chaque événement pour en savoir plus sur les données disponibles et les meilleures pratiques pour gérer ces événements.
⌘I