ts stromgedachtダウンロード - ts stromgedachtソースコードのダウンロード

ts stromgedacht

パワービルダー

v2.1.0

ダウンロード

ts-ストロンゲダクト

StromGedacht API を使用するための Typescript ライブラリ

インストール

npm で利用可能です。

npm install ts-stromgedacht

使用法

クライアントは、現時点のリージョンの状態、または特定の期間のすべての状態を提供できます。

期間は、将来の 2 日間および過去の 4 日間まで延長できます。

リクエストを行うたびに、州をリクエストしたい地域の郵便番号を入力する必要があります。

API ではすべてのオリジンが許可されているため、このライブラリは CORS エラーを発生せずにブラウザーで使用できます。

初期化

クライアントをnode_modulesからインポートするだけです。

 import { stromgedachtClient } from "ts-stromgedacht" ;

現在の状態を取得する

Nowメソッドを呼び出して地域の郵便番号を渡すことで、地域の現在の状態を取得できます。

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

API がエラーを返した場合、このメソッドはnullを返します。これは、郵便番号が無効であるかサポートされていない場合に発生する可能性があります。

期間の状態を取得する

Statesメソッドを呼び出し、地域の郵便番号、開始時刻、終了時刻を渡すことで、特定の期間の地域のすべての州を取得できます。

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

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

開始時刻と終了時刻は、この時点を基準とした時間にすることもできます。

 const hoursInPast = 24 ;
const hoursInFuture = 48 ;

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

API がエラーを返した場合、このメソッドは空の配列を返します。これは、郵便番号が無効であるかサポートされていない場合、またはサポート期間を超えている場合に発生する可能性があります。

予測を取得する

forecastメソッドを呼び出し、地域の郵便番号、開始時刻、終了時刻を渡すことで、特定の期間の地域の予測を取得できます。

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

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