Descarga de ts stromgedacht - Descarga del código fuente ts stromgedacht

ts stromgedacht

Generador de energía

v2.1.0

Descargar

ts-stromgedacht

Biblioteca mecanografiada para usar la API StromGedacht

Instalación

Disponible en npm.

npm install ts-stromgedacht

Uso

El cliente puede proporcionar el estado de la región en el momento actual o todos los estados durante un período de tiempo determinado.

El plazo podrá extenderse como máximo 2 días hacia el futuro y 4 días hacia el pasado.

Cada vez que realice una solicitud, deberá proporcionar el código postal de la región para la cual desea solicitar el estado.

Dado que la API permite todos los orígenes, esta biblioteca se puede utilizar en un navegador sin errores CORS.

Inicialización

Simplemente importe el cliente desde su node_modules.

 import { stromgedachtClient } from "ts-stromgedacht" ;

Obtener el estado actual

Puede obtener el estado actual de una región llamando al método Now y pasando el código postal de la región.

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

Si la API devuelve un error, este método devuelve null . Esto podría suceder si el código postal no es válido o no es compatible.

Obtener estados por período de tiempo

Puede recuperar todos los estados de una región durante un período de tiempo específico llamando al método States y pasando el código postal de la región, la hora de inicio y la hora de finalización.

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

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

La hora de inicio y finalización también pueden ser las horas relativas a este momento:

 const hoursInPast = 24 ;
const hoursInFuture = 48 ;

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

Si la API devuelve un error, este método devuelve una matriz vacía. Esto podría suceder si el código postal no es válido/no es compatible o si se excede el período admitido.

Obtener pronóstico

Puede obtener el pronóstico de una región para un período de tiempo específico llamando a los métodos forecast y pasando el código postal de la región, la hora de inicio y la hora de finalización.

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

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