@leaderty/index-variations
v1.0.4
Published
Paquete para obtener variaciones de índices económicos de Argentina (IPC) mediante un cron job diario.
Readme
@leaderty/index-variations
Paquete para obtener variaciones de índices económicos de Argentina (IPC) mediante un cron job diario.
Setup
npm install @leaderty/index-variationsFunciones
startIndexCronJob(cb, hour, fetchOnStartup?)
Inicia un cron job que obtiene los índices diariamente a la hora especificada (zona horaria Argentina).
Parámetros:
cb- Función callback que se ejecuta al obtener cada índicehour- Hora del día para ejecutar el cron (0-23)fetchOnStartup- Opcional, ejecuta el fetch inmediatamente al iniciar (default:true)
Retorna: Promise<CronJob>
getIPCVariation()
Obtiene la variación del IPC desde la API externa.
Retorna: Promise<{ value: number; date: Date }>
Throws: Error si la API retorna datos inválidos o con formato incorrecto
Types
interface IIndex {
index: string; // Nombre del índice (ej: 'IPC')
date: Date; // Fecha de publicación
value: number; // Valor del índice
}
type Callback = (index: IIndex) => Promise<void>