Members
(constant) URL_API :string
Constante contenant l'url vers le service API REST
Type:
- string
- Source:
(constant) dayOfWeek :Object.<number, string>
Objet contenant les abréviations des jours de la semaine. Les clés correspondent aux numéros des jours (1: lundi, 2: mardi, etc.).
Type:
- Object.<number, string>
- Source:
(constant) kinds :Object.<string, string>
Tableau d'objets contenant les labels associés à l'indice de la categorie Les clés correspondent à l'indice de la catégorie (1: cardio, etc...)
Type:
- Object.<string, string>
- Source:
(constant) metrics :Array.<MetricObject>
Tableau d'objets décrivant les propriétés métriques. Chaque objet mappe un libellé lisible à une clé technique utilisée dans un objet de données.
Type:
- Array.<MetricObject>
- Source:
Methods
(async) fetchApi(id, mocked, endpoints, …args) → {Promesse}
Fonction asynchrone générique permettant de récuperer des données en fonction de l'identifiant de l'utilisateur (id) et du chemin (endpoints) pour interroger un service
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
id |
number | Identifiant de l'utilisateur |
|
mocked |
boolean | Indique si les données doivent être "mocké" |
|
endpoints |
string | Endpoints de l'API REST |
|
args |
Array |
<repeatable> |
Liste des arguments à inclure dans l'appel de l'api |
- Source:
Returns:
Retourne une promesse
- Type
- Promesse
(async) fetchUserActivityApi(userId, mocked, …args) → {Promesse}
Fonction asynchrone permettant de récuperer des données de l'activité d'un utilisateur en fonction de son identifiant (userId)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
userId |
number | Identifiant de l'utilisateur |
|
mocked |
boolean | Indique si les données doivent être "mocké" |
|
args |
Array |
<repeatable> |
Liste des arguments à inclure dans l'appel de l'api |
- Source:
Returns:
Retourne une promesse
- Type
- Promesse
(async) fetchUserApi(id, mocked, …args) → {Promesse}
Fonction asynchrone permettant de récuperer des données d'un utilisateur en fonction de son identifiant (id).
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
id |
number | Identifiant de l'utilisateur |
|
mocked |
boolean | Indique si les données doivent être "mocké" |
|
args |
Array |
<repeatable> |
Liste des arguments à inclure dans l'appel de l'api |
- Source:
Returns:
Retourne une promesse
- Type
- Promesse
(async) fetchUserAverageSessionsApi(userId, mocked, …args) → {Promesse}
Fonction asynchrone permettant de récuperer des données sur la durée moyenne des sessions d'un utilisateur en fonction de son identifiant (userId)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
userId |
number | Identifiant de l'utilisateur |
|
mocked |
boolean | Indique si les données doivent être "mocké" |
|
args |
Array |
<repeatable> |
Liste des arguments à inclure dans l'appel de l'api |
Returns:
Retourne une promesse
- Type
- Promesse
(async) fetchUserPerformanceApi(userId, mocked, …args) → {Promesse}
Fonction asynchrone permettant de récuperer des données sur la performance d'un utilisateur en fonction de son identifiant (userId)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
userId |
number | Identifiant de l'utilisateur |
|
mocked |
boolean | Indique si les données doivent être "mocké" |
|
args |
Array |
<repeatable> |
Liste des arguments à inclure dans l'appel de l'api |
Returns:
Retourne une promesse
- Type
- Promesse
useFetch(id, fetcher, title, defaultData) → {UseFetchObject}
Hook de gestion du fetch des données en gérant le chargement, les erreurs et les données à récupèrer :
- data : Les données récupérées ou la valeur par défaut
- isLoading : Indicateur de chargement en cours
- isAborted : Indicateur d'annulation du chargement (est déclenché lorsque le composant est démonté, c'est souvent le cas avec le strict mode, qui effectue deux montage du composant)
- error : Contient le message d'erreur ou null
Parameters:
Name | Type | Description |
---|---|---|
id |
number | Identifiant de l'utilisateur |
fetcher |
function | Fonction asynchrone pour récupèrer les données (async) |
title |
string | Titre informatif des données pour l'affichage des données et des erreurs dans la console |
defaultData |
* | Données à utiliser par défaut |
- Source:
Returns:
Un objet
- Type
- UseFetchObject
useUser() → {React.Context}
Hook de retournant le contexte UserContext
- Source:
Returns:
Retourne le contexte de UserContext
- Type
- React.Context
Type Definitions
MetricObject
Objet définisant une métrique
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
label |
string | Libellé de la métrique |
unit |
string | Unité de la métrique |
icon |
any | Ressource représentant l'icône |
key |
string | La clé à utiliser pour accéder à la métrique |
- Source:
UseFetchObject
L'objet retournée par la fonction useFetch
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
data |
any | Les Les données récupérées ou la valeur par défaut |
|
isLoading |
boolean | Indicateur de chargement en cours |
|
isAborted |
boolean | Indicateur d'annulation du chargement (est déclenché lorsque le composant est démonté, c'est souvent le cas avec le strict mode, qui effectue deux montage du composant) |
|
error |
string |
<nullable> |
Contient le message d'erreur ou null si il n'y pas eu d'erreur |
- Source: