geonet/dist/src/services/NewsService.js

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

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.NewsService = void 0;
const base_1 = require("../../@types/base");
const BaseService_1 = require("./BaseService");
/**
 * NewsService class for fetching a simple JSON feed of GeoNet's news from the GeoNet API.
 * @extends BaseService
 * @since 1.0.0
 */
class NewsService extends BaseService_1.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
     */
    async getNews(page) {
        if (page && isNaN(page))
            throw new Error("Invalid page number, the page number must be an integer.");
        return await this.GET({
            endpoint: `/news/geonet${page ? `?page=${page}` : ""}`,
            format: base_1.JSONFormatTypes.APPLICATION_JSON_VERSION_2
        });
    }
}
exports.NewsService = NewsService;