Baixar ts stromgedacht - download do código-fonte ts stromgedacht

ts stromgedacht

PowerBuilder

v2.1.0

Baixar

ts-stromgedacht

Biblioteca Typescript para usar a API StromGedacht

Instalação

Disponível no npm.

npm install ts-stromgedacht

Uso

O cliente pode fornecer o estado da região no momento atual ou todos os estados em um determinado período.

O período pode se estender por no máximo 2 dias no futuro e 4 dias no passado.

Cada vez que você fizer uma solicitação, será necessário informar o CEP da região para a qual deseja solicitar o estado.

Como a API permite todas as origens, esta biblioteca pode ser usada em um navegador sem erros de CORS.

Inicialização

Basta importar o cliente do seu node_modules.

 import { stromgedachtClient } from "ts-stromgedacht" ;

Obtenha o estado atual

Você pode buscar o estado atual de uma região chamando o método Now e passando o CEP da região.

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

Se a API retornar um erro, este método retornará null . Isso pode acontecer se o CEP for inválido/incompatível.

Obtenha estados por período de tempo

Você pode buscar todos os estados de uma região por um período de tempo específico chamando o método States e passando o CEP da região, o horário de início e o horário de término.

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

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

Os horários de início e término também podem ser as horas relativas a este momento:

 const hoursInPast = 24 ;
const hoursInFuture = 48 ;

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

Se a API retornar um erro, este método retornará um array vazio. Isso pode acontecer se o CEP for inválido/incompatível ou se o período suportado for excedido.

Obter previsão

Você pode buscar a previsão de uma região para um período específico chamando os métodos forecast e passando o CEP da região, o horário de início e o horário de término.

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

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