image

Module image

Mots-clés : gout, gout-module, gout-module-image.

Ce module affiche des images.

Options

Les options sont dans un objet YAML avec les propriétés suivantes :

Nom	Type	Description
cron	string string[]	La ou les expressions cron indiquant la fréquence de mise à jour. Sans cette propriété, les données ne sont jamais mises à jour. Exemple : "*/5 * * * *"
empty	object	Les données affichées quand les scrapers n'ont retourné aucune donnée. Ce doit être un objet avec les mêmes propriétés qu'un élément retourné par les scrapers. Si cette propriété n'est pas renseignée, le module est laissé vide. Exemple : title: "(aucun élément)"
max	number	Le nombre maximum d'éléments affichés dans le module. Sans maximum, tous les éléments retournés par les scrapers sont affichés. Exemple : 5

Scrapers

Note

Ce chapitre est utile principalement pour le développement de scrapers compatibles avec ce module.

Les scrapers associés à ce module doivent définir une méthode extract() qui prend en paramètre un entier indiquant le nombre maximum d'éléments à retourner. La méthode doit retourner une promesse contenant un tableau dont chaque élément est un objet ayant les propriétés suivantes :

Nom	Type	Description
date	number	Le nombre de millisecondes depuis le 1er janvier 1970 à 00:00:00 UTC (cf. Date.prototype.getTime()). Cette valeur est utilisée pour trier les éléments du plus récent au plus ancien. Par défaut, le nombre 0 est utilisé. Exemple : 900277200000
guid	string	Un identifiant de l'élément (globally unique identifier) qui sera utilisé pour savoir s'il faut mettre à jour un élément ou en insérer un nouveau. Par défaut, il est calculé à partir des autres propriétés. Exemple : "example.com:12345"
img	string	L'URL de l'image affichée. Par défaut, aucune image n'est affichée. Exemple : "https://example.com/foo/bar.jpg"
link	string	Le lien de l'élément. Par défaut, il n'y a pas de lien (mais l'image est affichée). Exemple : "https://example.com/foo/bar.html"
target	string	L'emplacement où sera ouvert le lien (cf. l'attribut target des liens HTML). Par défaut, les liens s'ouvrent dans un nouvel onglet. Exemple : "_top"
title	string	Le titre de l'élément affiché dans l'infobulle. Par défaut, aucune infobulle n'est affichée. Exemple : "Magnifique photo !"

Exemple

Ce widget affiche les 3 dernières images du site CommitStrip avec une mise à jour à minuit.

<script type="application/yaml">
  module:
    url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/image/image.js"
    options:
      cron: "@daily"
      max: 3
    scrapers:
      - url: "https://cdn.jsdelivr.net/gh/regseb/gout-regseb@0/src/scraper/image/commitstrip/commitstrip.js"
</script>