@appleparan/kma-mcp-server / clients/buoy / BuoyClient
Class: BuoyClient¶
Defined in: src/clients/buoy.ts:20
Extends¶
Constructors¶
Constructor¶
new BuoyClient(
config):BuoyClient
Defined in: src/clients/buoy.ts:21
Parameters¶
config¶
Returns¶
BuoyClient
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¶
getBuoyData()¶
getBuoyData(
tm,buoyId):Promise\<BuoyObservation[]>
Defined in: src/clients/buoy.ts:30
Get buoy observation data for a specific time
Parameters¶
tm¶
Observation time in YYYYMMDDHHmm format or Date object
string | Date
buoyId¶
Buoy ID (0 for all buoys)
string | number
Returns¶
Promise\<BuoyObservation[]>
getBuoyPeriod()¶
getBuoyPeriod(
tm1,tm2,buoyId):Promise\<BuoyObservation[]>
Defined in: src/clients/buoy.ts:44
Get buoy observation data for a time period
Parameters¶
tm1¶
Start time in YYYYMMDDHHmm format or Date object
string | Date
tm2¶
End time in YYYYMMDDHHmm format or Date object
string | Date
buoyId¶
Buoy ID (0 for all buoys)
string | number
Returns¶
Promise\<BuoyObservation[]>
getComprehensiveMarineData()¶
getComprehensiveMarineData(
tm):Promise\<BuoyObservation[]>
Defined in: src/clients/buoy.ts:62
Get comprehensive marine data (buoys, tide, wave)
Parameters¶
tm¶
Observation time in YYYYMMDDHHmm format or Date object
string | Date
Returns¶
Promise\<BuoyObservation[]>
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[]>