ts stromgedacht

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 ) ;

API 速率限制

該 API 限制為每分鐘約 6 個請求。

有關的

以下是一些相關項目：

• StromGedacht.NET：該程式庫的 C# 版本

喊出來

所使用的 API 由 StromGedacht, TransnetBW GmbH 提供。