geonet
Version:
A Node.js API wrapper for GeoNet — Aotearoa's geological hazard monitoring system.
19 lines (18 loc) • 745 B
TypeScript
import { BaseServiceGETRequest } from "../../@types/base";
/**
* BaseService class to handle common HTTP requests to the GeoNet API.
* @abstract
* @since 1.0.0
*/
export declare abstract class BaseService {
protected readonly baseURL = "https://api.geonet.org.nz";
/**
* Performs a GET request to the specified endpoint.
*
* @param {BaseServiceGETRequest} req - The request object containing the endpoint and format.
* @returns {Promise<any>} - A promise that resolves to the response data.
* @throws {Error} - Throws an error if the endpoint is not provided, is not a string, or does not start with a backslash (/).
* @since 1.0.0
*/
protected GET(req: BaseServiceGETRequest): Promise<any>;
}