ts stromgedacht Télécharger - ts stromgedacht Téléchargement du code source

ts stromgedacht

Générateur de puissance

v2.1.0

Télécharger

ts-stromgedacht

Bibliothèque Typescript pour utiliser l'API StromGedacht

Installation

Disponible sur npm.

npm install ts-stromgedacht

Usage

Le client peut fournir l'état de la région à l'heure actuelle ou tous les états pour une période donnée.

Le délai peut s'étendre au maximum sur 2 jours dans le futur et 4 jours dans le passé.

Chaque fois que vous ferez une demande, vous devrez fournir le code postal de la région pour laquelle vous souhaitez demander l'État.

Puisque l'API autorise toutes les origines, cette bibliothèque peut être utilisée dans un navigateur sans erreurs CORS.

Initialisation

Importez simplement le client depuis vos node_modules.

 import { stromgedachtClient } from "ts-stromgedacht" ;

Obtenir l'état actuel

Vous pouvez récupérer l'état actuel d'une région en appelant la méthode Now et en transmettant le code postal de la région.

 const state = await stromgedachtClient . now ( "70173" ) ;

Si l'API renvoie une erreur, cette méthode renvoie null . Cela peut se produire si le code postal n'est pas valide/n'est pas pris en charge.

Obtenir les états pour la période

Vous pouvez récupérer tous les états d'une région pour une période spécifique en appelant la méthode States et en transmettant le code postal de la région, l'heure de début et l'heure de fin.

 const from = new Date ( "2023-01-01" ) ;
const to = new Date ( "2023-01-03" ) ;

const states = stromgedachtClient . states ( "70173" , from , to ) ;

L'heure de début et de fin peut également être les heures relatives à ce moment :

 const hoursInPast = 24 ;
const hoursInFuture = 48 ;

const states = stromgedachtClient . statesRelative ( "70173" , hoursInPast , hoursInFuture ) ;

Si l'API renvoie une erreur, cette méthode renvoie un tableau vide. Cela peut se produire si le code postal est invalide/non pris en charge ou si la période prise en charge est dépassée.

Obtenir des prévisions

Vous pouvez récupérer les prévisions d'une région pour une période spécifique en appelant les méthodes forecast et en transmettant le code postal de la région, l'heure de début et l'heure de fin.

 const from = new Date ( "2023-01-01" ) ;
const to = new Date ( "2023-01-03" ) ;

const forecast = stromgedachtClient . forecast ( "70173" , from , to ) ;