Class NetworkService

NetworkService class for fetching network sensor, GNSS mark and FDSN station information from the GeoNet API.

Since

1.0.0

Hierarchy (View Summary)

BaseService
- NetworkService

Index

Constructors

Methods

getNetworkFDSNDetails getNetworkGNSSDetails getNetworkSensor

Constructors

constructor

new NetworkService(): NetworkService

Returns NetworkService

Inherited from BaseService.constructor

Methods

getNetworkFDSNDetails

getNetworkFDSNDetails(
req: NetworkFDSNStationRequest,
): Promise<NetworkFDSNStationResponse>
Fetches network data for a specified FDSN station.
Parameters
- req: NetworkFDSNStationRequest
  The request object containing the station and network codes.
Returns Promise<NetworkFDSNStationResponse>
- A promise that resolves to the sensor details data.
Throws
- Throws an error if the station or network code is not provided, or is not a string.
Since
1.0.0
- Defined in src/services/NetworkService.ts:73

getNetworkGNSSDetails

getNetworkGNSSDetails(code: string): Promise<NetworkGNSStationResponse>
Fetches network data for a specified GNSS mark.
Parameters
- code: string
  The mark code.
Returns Promise<NetworkGNSStationResponse>
- A promise that resolves to the sensor details data.
Throws
- Throws an error if the mark code is not provided.
Since
1.0.0
- Defined in src/services/NetworkService.ts:56

getNetworkSensor

getNetworkSensor(req: NetworkSensorRequest): Promise<NetworkSensorResponse>
Fetches network data for a given sensor type.
Parameters
- req: NetworkSensorRequest
  The request object containing the sensor type.
Returns Promise<NetworkSensorResponse>
- A promise that resolves to the sensor data.
Throws
- Throws an error if the sensor type is not provided, or if the optional parameters are not strings.
Since
1.0.0
- Defined in src/services/NetworkService.ts:19