1.27.0 • Published 4 years ago
pyptron v1.27.0
Modulo para calcular el Pico y Placa en las distintas ciudades de Colombia.
Instalación
npm i pyptron
Uso
Pyptron exporta dos funciones para acceder a la información disponible del Pico y Placa. Toda la información está contenida en el módulo y el cálculo para obtener el número al que le corresponde el pico y placa en un día determinado se hace en el momento en que se hace la solicitud de la información.
Las dos funciones disponibles por medio de pyptron
son:
getCitiesMap()
: Devuelve un objecto con las ciudades disponibles y las categorías disponibles para cada ciudad.getCityData(city[, options])
: Devuelve la información disponible para la ciudad solicitada de acuerdo con las opciones dadas.
getCitiesMap
Devuelve un objeto con las ciudades disponibles y las categorías disponibles para cada ciudad.
const { getCitiesMap } = require('pyptron');
const citiesMap = getCitiesMap();
getCityData
Devuelve la información disponible para la ciudad solicitada de acuerdo con las opciones dadas.
const { getCityData } = require('pyptron')
const pypData = getCityData('bogota', { categories: ['particulares', 'taxis'], date: '2019-05-15', days=15 })
Argumentos
Argumento | Descripción |
---|---|
city | String - El nombre de la ciudad correspondiente al valor key de la ciudad en el objeto devuelto por la función getCitiesMap . |
[options] | Objeto - Opciones que se desean para la ciudad. Si se omite, se devuelve la información para todas las categorías de la ciudad solicitada correspondientes a la fecha actual. |
Las opciones no son requeridas y se pueden incluir cualquiera de las siguientes.
Opción | Descripción |
---|---|
categories | Array - La categorías que se desean consultar según el valor key de la categoría como es devuelto por la función getCitiesMap . Si se omite o se pasa un Array vacio se devuelven todas las categorías disponibles para la ciudad. |
date | String - La fecha para la cual se solicita la información en formato YYYY-MM-DD . Si se omite se usa por defecto la fecha actual. |
days | Integer - La cantidad de días que se desean consultar. Por defecto se usa el valor de 1 . Se pueden solicitar un máximo de 30 días, si se pasa un número mayor a 30 se devolverán 30 días. |