UNPKG

aemet-api

Version:

Cliente TypeScript para la API de AEMET (Agencia Estatal de Meteorología)

43 lines (42 loc) 1.73 kB
/** * Utilidades para la librería de AEMET */ /** * Realizar una petición GET a la API de AEMET y descargar los datos * @param url - URL del endpoint de la API * @param apiKey - Clave de API AEMET * @param timeout - Timeout para la petición en milisegundos * @returns - Datos procesados de la respuesta con número de intentos realizados */ export declare function fetchAemetData(url: string, apiKey: string, timeout?: number): Promise<any>; /** * Obtener descripción del estado del cielo a partir de su código * @param code - Código del estado del cielo * @returns - Descripción del estado del cielo */ export declare function getSkyStateDescription(code: string): string; /** * Formatea una fecha como YYYY-MM-DD * @param date - Fecha a formatear * @returns - Fecha formateada */ export declare function formatDate(date: Date): string; /** * Extrae la predicción para un día específico * @param forecast - Datos completos de la predicción * @param date - Fecha para la que se quiere la predicción (o 0 para hoy, 1 para mañana, 2 para pasado mañana) * @returns - Predicción para el día especificado */ export declare function getDayForecast(forecast: any[], date: Date | number): any; /** * Descargar un archivo binario desde la API de AEMET * Especialmente útil para archivos como .tar que no son JSON * @param url - URL del endpoint de la API * @param apiKey - Clave de API AEMET * @param timeout - Timeout para la petición en milisegundos * @returns - Buffer con los datos binarios del archivo y número de intentos realizados */ export declare function fetchAemetBinaryFile(url: string, apiKey: string, timeout?: number): Promise<{ data: Buffer; intentos: number; }>;