docs: add type documentation

maelgangloff · Apr 27, 2024 · 6f8a3fd · 6f8a3fd
1 parent e0a3f59
commit 6f8a3fd
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 15 deletions.
diff --git a/src/components/PCE/Consommation.ts b/src/components/PCE/Consommation.ts
@@ -19,28 +19,33 @@ export interface Consommation {
       volumeBrutConsomme: number
       energieConsomme: number
       /**
-       * Pouvoir Calorifique Supérieur du Gaz.
+       * PCS : Pouvoir Calorifique Supérieur du Gaz.
        * Il s'agit de la « quantité d'énergie dégagée par la combustion complète d'une unité de combustible, la vapeur d'eau étant supposée condensée et la chaleur récupérée ».
        */
-      pcs: any
+      pcs: string|number|null
       /**
        * Volume de gaz consommé sur la période en conditions normales, c'est à dire sous une pression de 1 bar et une température de 0°C.
        */
       volumeConverti: number|null
       /**
-       * Coefficient lié aux conditions de température, pression et altitude au moment du relevé
+       * PTA : Pression Température Altitude.
+       * Coefficient lié aux conditions de température, pression et altitude au moment du relevé.
+       */
+      pta: string|number|null
+      /**
+       * - Publiée : Données de consommation journalières individuelles (uniquement pour les compteurs 1M et les MM).
+       * - Informative Journalier : Données de consommation individuelles envoyées aux fournisseurs et permettant la facturation.
        */
-      pta: any
       natureReleve: 'Publiée' | 'Informative Journalier' | string
       qualificationReleve: 'Estimé' | 'Mesuré' | 'Absence de Données' | string
-      status: any
+      status: string|null
       /**
        * Coefficient produit du PTA et du PCS, calculé suivant la valeur moyenne sur la période de consommation.
        */
       coeffConversion: number
-      frequenceReleve: any
-      temperature: any
+      frequenceReleve: string|null
+      temperature: string|number|null
     }>
-    frequence: any
+    frequence: string|null
   }
 }
diff --git a/src/components/User/Accreditation.ts b/src/components/User/Accreditation.ts
@@ -32,9 +32,9 @@ export interface Accreditation {
   }
   donnees_techniques: {
     alias: string
-    canal_creation: any
-    application: any
-    id_internaute_referentiel: any
+    canal_creation: string|null
+    application: string|null
+    id_internaute_referentiel: string|null
     date_creation: string
     date_premiere_accreditation: string|null
     date_suppression: string|null
@@ -53,12 +53,12 @@ export interface Accreditation {
     origine_passage_a_refuse: string|null
     source_passage_a_refuse: string|null
   }
-  parametres_validation: any
+  parametres_validation: string|null
   informations_complementaires: {
     POURACCRED_DENOMINATION: string
     ID_ESPACE_PERSO_ACCRED: string
     CODE_TYPE_RESIDENCE: string
     SEQ: string
   }|[]
-  donnees_controle: any
+  donnees_controle: string|null
 }
diff --git a/src/components/User/UserInfo.ts b/src/components/User/UserInfo.ts
@@ -10,8 +10,8 @@ export interface UserInfo {
   espace: {
     id: number
     mobile_phone: string
-    validated_mobile_phone: any
-    mobile_phone_expiration_date: any
+    validated_mobile_phone: string|null
+    mobile_phone_expiration_date: string|null
     home_phone: string
     notification_info_coupure_sms: boolean
     notification_info_coupure_email: boolean