ts stromgedacht Download - ts stromgedacht Quellcode herunterladen

ts stromgedacht

PowerBuilder

v2.1.0

Herunterladen

ts-stromgedacht

Typescript-Bibliothek zur Verwendung der StromGedacht-API

Installation

Verfügbar auf npm.

npm install ts-stromgedacht

Verwendung

Der Client kann den Regionsstatus zum aktuellen Zeitpunkt oder alle Status für einen bestimmten Zeitraum bereitstellen.

Der Zeitraum darf maximal 2 Tage in die Zukunft und 4 Tage in die Vergangenheit reichen.

Bei jeder Anfrage müssen Sie die Postleitzahl der Region angeben, für die Sie den Bundesstaat anfordern möchten.

Da die API alle Ursprünge zulässt, kann diese Bibliothek in einem Browser ohne CORS-Fehler verwendet werden.

Initialisierung

Importieren Sie einfach den Client aus Ihren node_modules.

 import { stromgedachtClient } from "ts-stromgedacht" ;

Aktuellen Status abrufen

Sie können den aktuellen Status einer Region abrufen, indem Sie die Now -Methode aufrufen und die Postleitzahl der Region übergeben.

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

Wenn die API einen Fehler zurückgibt, gibt diese Methode null zurück. Dies kann passieren, wenn die Postleitzahl ungültig ist/nicht unterstützt wird.

Rufen Sie Zustände für einen Zeitraum ab

Sie können alle Bundesstaaten einer Region für einen bestimmten Zeitraum abrufen, indem Sie die States -Methode aufrufen und die Postleitzahl der Region sowie die Start- und Endzeit übergeben.

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

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

Start- und Endzeit können auch die Stunden relativ zu diesem Zeitpunkt sein:

 const hoursInPast = 24 ;
const hoursInFuture = 48 ;

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

Wenn die API einen Fehler zurückgibt, gibt diese Methode ein leeres Array zurück. Dies kann passieren, wenn die Postleitzahl ungültig ist/nicht unterstützt wird oder der unterstützte Zeitraum überschritten wird.

Holen Sie sich eine Prognose

Sie können die Prognose einer Region für einen bestimmten Zeitraum abrufen, indem Sie die forecast aufrufen und die Postleitzahl der Region sowie die Start- und Endzeit übergeben.

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

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