Librería para el pico y placa en Colombia


Keywords
Colombia, Pico y placa
License
MIT
Install
npm install pypbot@3.4.1

Documentation

pypbot 🚕 🚌 🚗

Build Status Coverage Status David David

Permite obtener información sobre las medidas de restricción vehícular en Colombia para las diferentes ciudades en que aplica.

Se usa para generar la página pico y placa hoy que muestra la información diaria del pico y placa para las diferentes ciudades.

Instalación

Para instalarlo como una dependencia en un proyecto con npm:

npm install pypbot

Uso

La función getPypData(city, date, days = 1, categories = []) permite obtener la información del pico y placa para una ciudad y una fecha en particular:

const pypbot = require("pypbot");

// La fecha para la cual deseamos saber el pico y placa.
const date = new Date();

// La ciudad para la cual deseamos saber el pico y placa.
const city = "cali";

const pypCali = pypbot.getPypData(city, date);

Adicionalmente, se puede especificar las categorías que se desean consultar y la cantidad de días a partir de la fecha solicitada que se desean consultar:

// La fecha para la cual deseamos saber el pico y placa.
const date = new Date();

// La ciudad para la cual deseamos saber el pico y placa.
const city = "bogota";

// La cantidad de días a partir de la fecha que deseamos consultar. Por defecto
// es 1, lo que devuelve los datos sólo para la fecha solicitada.
const days = 7;

// Las categorías de pico y plaa que deseamos consultar. Por defecto es un array
// vacio que indica que se van a consultar todas las categorías disponibles para
// la ciudad solicitada.
const categories = ["ambiental", "taxis"];

const pypBogota = pypbot.getPypData(city, date, days, categories);

En el ejemplo anterior bogota será un objeto con la información del pico y placa para las categorías ambiental y taxis de la ciudad de bogota para siete días a partir de la fecha solicitada.

Se puede obtener una lista de las ciudades con sus respectivas categorías con la función getCities():

pypbot.getCities();

De manera similar se pueden consultar todas las categorías disponibles para una ciudad en particular:

pypbot.getCategories("medellin");

Licencia

MIT.