@appleparan/kma-mcp-server / clients/warning / WarningClient
Class: WarningClient¶
Defined in: src/clients/warning.ts:18
Extends¶
Constructors¶
Constructor¶
new WarningClient(
config):WarningClient
Defined in: src/clients/warning.ts:19
Parameters¶
config¶
Returns¶
WarningClient
Overrides¶
Properties¶
authKey¶
protectedauthKey:string
Defined in: src/clients/base.ts:43
Inherited from¶
client¶
protectedclient:AxiosInstance
Defined in: src/clients/base.ts:42
Inherited from¶
Methods¶
formatDateTime()¶
protectedformatDateTime(date,includeTime):string
Defined in: src/clients/base.ts:96
Format datetime to KMA API format (YYYYMMDDHHmm or YYYYMMDD)
Parameters¶
date¶
Date
includeTime¶
boolean = true
Returns¶
string
Inherited from¶
getCurrentWarnings()¶
getCurrentWarnings():
Promise\<WarningData[]>
Defined in: src/clients/warning.ts:26
Get current active weather warnings
Returns¶
Promise\<WarningData[]>
getSpecialWeatherReport()¶
getSpecialWeatherReport(
tm):Promise\<WarningData[]>
Defined in: src/clients/warning.ts:46
Get special weather report
Parameters¶
tm¶
string
Time in YYYYMMDDHHmm format
Returns¶
Promise\<WarningData[]>
getWarningHistory()¶
getWarningHistory(
tm1,tm2):Promise\<WarningData[]>
Defined in: src/clients/warning.ts:35
Get warning history for a time period
Parameters¶
tm1¶
string
Start time in YYYYMMDDHHmm format
tm2¶
string
End time in YYYYMMDDHHmm format
Returns¶
Promise\<WarningData[]>
makeRequest()¶
protectedmakeRequest\<T>(endpoint,params):Promise\<T[]>
Defined in: src/clients/base.ts:56
Type Parameters¶
T¶
T = unknown
Parameters¶
endpoint¶
string
params¶
Record\<string, unknown>
Returns¶
Promise\<T[]>