1.18.0 • Published 5 years ago

@picoyplaca/pyptron v1.18.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

pyptron

CircleCI codecov Greenkeeper badge

Modulo para calcular el Pico y Placa en las distintas ciudades de Colombia.

Pico y placa

Instalación

npm i @picoyplaca/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('@picoyplaca/pyptron')
const citiesMap = getCitiesMap()

getCityData

Devuelve la información disponible para la ciudad solicitada de acuerdo con las opciones dadas.

const { getCityData } = require('@picoyplaca/pyptron')
const pypData = getCityData('bogota', { categories: ['particulares', 'taxis'], date: '2019-05-15', days=15 })

Argumentos

ArgumentoDescripción
cityString - 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ónDescripción
categoriesArray - 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.
dateString - 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.
daysInteger - 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.

Licencia

FOSSA Status

1.18.0

5 years ago

1.17.0

5 years ago

1.16.0

5 years ago

1.15.0

5 years ago

1.14.2

5 years ago

1.14.1

5 years ago

1.14.0

5 years ago

1.13.0

5 years ago

1.12.0

5 years ago

1.11.4

6 years ago

1.11.3

6 years ago

1.11.2

6 years ago

1.11.1

6 years ago

1.11.0

6 years ago

1.10.0

6 years ago

1.9.0

6 years ago

1.8.0

6 years ago

1.7.0

6 years ago

1.6.2

6 years ago

1.6.1

6 years ago

1.6.0

6 years ago

1.5.1

6 years ago

1.5.0

6 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago