geonet/dist/src/services/VolcanoService.d.ts

A Node.js API wrapper for GeoNet — Aotearoa's geological hazard monitoring system.

import { VolcanoAlertLevelResponse, VolcanoID, VolcanoQuakeResponse } from "../../@types/volcano";
import { BaseService } from "./BaseService";
/**
 * VolcanoService class for volcanic alert level information and volcano earthquakes from the GeoNet API.
 * @extends BaseService
 * @since 1.0.0
 */
export declare class VolcanoService extends BaseService {
    /**
     * 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
     */
    getVolcanoAlertLevel(): Promise<VolcanoAlertLevelResponse>;
    /**
     * Fetches quakes in the vicinity of the volcano within a pre-defined region by GeoNet over the past 60 days.
     *
     * @param {VolcanoID} volcanoID - The request object containing the volcano ID.
     * @returns {Promise<VolcanoQuakeResponse>} - A promise that resolves to the volcano quake data.
     * @throws {Error} - Throws an error if the volcano ID is not provided or is not a valid volcano ID.
     * @since 1.0.0
     */
    getVolcanoQuakes(volcanoID: VolcanoID): Promise<VolcanoQuakeResponse>;
}