geonet
Version:
A Node.js API wrapper for GeoNet — Aotearoa's geological hazard monitoring system.
19 lines (18 loc) • 748 B
TypeScript
import { NewsFeedResponse } from "../../@types/news";
import { BaseService } from "./BaseService";
/**
* NewsService class for fetching a simple JSON feed of GeoNet's news from the GeoNet API.
* @extends BaseService
* @since 1.0.0
*/
export declare class NewsService extends BaseService {
/**
* Fetches a simple JSON feed of GeoNet's news.
*
* @param {number} page - The request parameters for fetching the news feed. If empty, the first page is returned.
* @returns {Promise<NewsFeedResponse>} - A promise that resolves to the simple JSON news feed data.
* @throws {Error} - Throws an error if the page number is not an integer.
* @since 1.0.0
*/
getNews(page?: number): Promise<NewsFeedResponse>;
}