Skip to content

LauriFernandez/CSVMarees

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CSVMarees

Description de la librairie

Cette librairie permets de charger les données issus d'un document CSV fournis par le gourvenment canadien sur la prévision des marrées. Elle peut-être utiliseé sur wordpress, comme sur un site static. Elle est simple d'utilisation et utilise des librairies externe, tel que Papaparse et date-fns.

Lien de téléchargement de la libraire

Fonctions disponible (V2)

fetchCSVMarees(link, intervalDay)

Cette fonction permets de retourner un array contenant les dates en ISO avec l'heure ainsi que la hauteur en mètre de la marée. Les prédictions commence toujours à partir du jours et de l'heure de la requète.

Elle prends deux paramètres:

  • link : string contenant le lien vers le fichier csv à charger
  • intervalDay : entier pour indiquer le nombre de jours de prévision souhaité (mettre 0 si on ne souhaite pas de limite)

Son utilisation doit se faire dans une fonction asynchrone pour premmetre la récupération des données avec un await.

Exemple d'utilisation

async function showData() {
    const values = await csvMarees.fetchCSVMarees("annuelles_Matane_2025.csv",4); // Renvoie les prédictions d'aujourdhui et des 3 prochains jours
    // traitement des données depuis values
}
showData();

fetchIntervalMarees(link, nbDayBefore, nbDayAfter)

Cette fonction permets de retourner un array contenant les dates en ISO avec l'heure ainsi que la hauteur en mètre de la marée. On peut lui donner un interval de journée avant et après pour avoir les données sur plusieurs jours.

Elle prends trois paramètres:

  • link : string contenant le lien vers le fichier csv à charger
  • nbDayBefore : entier représentant le nombre de jours précédent à aujourd'hui que nous souhaitons avoir (mettre 0 si on ne souhaite pas de limite)
  • nbDayAfter : entier représentant le nombre de jours suivant à aujourd'hui que nous souhaitons avoir (mettre 0 si on ne souhaite pas de limite)

Son utilisation doit se faire dans une fonction asynchrone pour premmetre la récupération des données avec un await.

Exemple d'utilisation

async function showData() {
    const values = await csvMarees.fetchIntervalMarees("annuelles_Matane_2025.csv",7,4); // Renvoie les prédictions d'il y a une semaine au 4 prochains jours
    // traitement des données depuis values
}
showData();

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published