@ix-xs/twitch.api 1.0.0 → 1.0.3

package/README.md

@@ -17,14 +17,27 @@ const client = new MetamobAPI({ clientId:"votre_id_client", clientSecret:"votre_
 ```
 
 <br>
-<h3>2. Liste des appels possibles</h3>
+<h3>2. Initialisez le client :</h3>
+
+```js
+await client.initialize();
+```
+
+<p>Pour démarrer correctement le client, il est nécessaire d'appeler la fonction <code>initialize()</code>. Cette dernière permet de mettre en place un système de validation periodique du token, effectué automatiquement une fois par heure. En raison de cette vérification régulière, l'utilisation de la console de développement devient indisponible pendant le processus.<br><br>Pour éviter ce problème, il est recommandé de faire tourner l'application en arrière-plan (via un service comme PM2, screen, ou tout autre gestionnaire de processus) afin de s'assurer que la validation continue de fonctionner sans interrompre votre environnement de travail.</p>
+
+<br>
+<h3>3. Liste des appels possibles</h3>
 <br>
 
 Méthode | options | Description |
 | --- | --- | --- |
+| `initialize()` |  | 👀 **Démarre le client**<br>💡 **Note** : Cette fonction est requise afin de démarrer la surveillance du token qui doit maintenant être valider toutes les heures |
 | `generateToken()` |  | 👀 **Génère un nouveau token**<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion|
-| `isExpiredToken()` |  | 👀 **Renvoi la validité du token actuel** (true ou false) |
+| `isExpiredToken()` |  | 👀 **Renvoi la validité du token actuel** (true ou false)<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion |
 | `refreshToken()` |  | 👀 **Génère un nouveau token**<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion |
+| `validateToken()` |  | 👀 **Valide le token**<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion |
+| `updateTokenFile()` |  | 👀 **Met à jour le token**<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion |
+| `startPeriodicValidation()` |  | 👀 **Démarre la surveillance pour la validation periodique du token (toutes les heures)**<br>💡 **Note** : Le token se gère de façon automatique, cette fonction sert uniquement a son auto-gestion |
 | `getStreams()` | {<br>`users_names?`:Array\<string\>;<br>`games_names?`:Array\<string\>;<br>`type?`:"all"\|"live";<br>`languages?`:Array\<string\>;<br>`first?`:number;<br>`before?`:string;<br>`after?`:string;<br>} | 👀 **Renvoi une liste des streams**<br>💡 **Note** : La liste est classée par ordre décroissant du nombre de téléspectateurs regardant le flux. Étant donné que les spectateurs vont et viennent pendant un flux, il est possible de trouver des flux en double ou manquants dans la liste au fur et à mesure que vous parcourez les résultats. |
 | `getUsers()` | `usernames`:Array\<string\>; | 👀 **Renvoi les informations d'un ou plusieurs utilisateur(s)** |
 | `getCheermotes()` |  | 👀 **Renvoi une liste de Cheermotes que les utilisateurs peuvent utiliser pour encourager Bits dans la salle de discussion de n'importe quelle chaîne compatible Bits.**<br>💡 **Note** : Les cheermotes sont des émoticônes animées auxquelles les spectateurs peuvent attribuer des Bits. |

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@ix-xs/twitch.api",
-  "version": "1.0.0",
-  "description": "Twitch API JS",
-  "main": "twitchapi.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "github.com/ix-xs/twitch.api"
-  },
-  "keywords": [
-    "Twitch",
-    "API",
-    "JS"
-  ],
-  "author": "ix-xs",
-  "license": "ISC"
+{
+    "name": "@ix-xs/twitch.api",
+    "version": "1.0.3",
+    "description": "Twitch API JS",
+    "main": "twitchapi.js",
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "repository": {
+      "type": "git",
+      "url": "github.com/ix-xs/twitch.api"
+    },
+    "keywords": [
+      "Twitch",
+      "API",
+      "JS"
+    ],
+    "author": "ix-xs",
+    "license": "ISC"
 }