Class VolcanoService

VolcanoService class for volcanic alert level information and volcano earthquakes from the GeoNet API.

Since

1.0.0

Hierarchy (View Summary)

BaseService
- VolcanoService

Index

Constructors

Methods

getVolcanoAlertLevel getVolcanoQuakes

Constructors

constructor

new VolcanoService(): VolcanoService
Returns VolcanoService
Inherited from BaseService.constructor

Methods

getVolcanoAlertLevel

getVolcanoAlertLevel(): Promise<VolcanoAlertLevelResponse>
Fetches the volcanic alert level data for every volcano.

Returns Promise<VolcanoAlertLevelResponse>
- A promise that resolves to the volcanic alert level data.
Since
1.0.0
- Defined in src/services/VolcanoService.ts:17

getVolcanoQuakes

getVolcanoQuakes(volcanoID: VolcanoID): Promise<VolcanoQuakeResponse>
Fetches quakes in the vicinity of the volcano within a pre-defined region by GeoNet over the past 60 days.
Parameters
- volcanoID: VolcanoID
  The request object containing the volcano ID.
Returns Promise<VolcanoQuakeResponse>
- A promise that resolves to the volcano quake data.
Throws
- Throws an error if the volcano ID is not provided or is not a valid volcano ID.
Since
1.0.0
- Defined in src/services/VolcanoService.ts:32