Gjirafa Bus module

Background

The Republic Of Kosovo doesn't have much on-line presence of platforms that give informations about public services. Bus transport service is one of those. While Gjirafa offers the most reliable informations regarding the schedules of the buses, it doesn't offer, let's say, an English version of the said service for the international audience. This tool could be used to create the missing platform or various other platforms, according to your creativity.

Description

This tool parses the page of interest, Gjirafa Linja te autobuseve (eng. Gjirafa bus lines) using the request module. Then, the parsed web page is scrapped using the cheerio module. Cheerio uses JQuery traversing methods to go through DOM elements.

Installation

The module can be installed using npm install gjirafaapi. The module is dependent on Cheerio and Request native.

Usage

After the installation, the module could be used in the following way:

const gjirafa = require('gjirafaapi');
 gjirafa("ferizaj","prishtine","14-7").then((result)=>console.log(result));

The method receives three parameters:

| Parameter | Context to be used by | Type | Format| | ------------- | ------------- | -----------|--------| | from | Departure place | String | Conversion to a strict format is not needed. The webpage will return valid results even if we write City, cit or ci as long as there are no other objects with the respective names. | to | Destination place | String | Conversion to a strict format is not needed. The webpage will return valid results if we write City, cit or ci as long as there are no other objects with the respective names. | date | Date of travel | String | DD-MM

The function always returns a promise and as such it should be caught with then. The result is an array of JSON objects. Those objects contain three properties: from and date - which consist of time information and operator with the operating company's name.

License

All the rights belong to the owners of the page of our interest. This module is created with the intention to encourage developers create compact platforms of public services in the Republic of Kosovo.

Info

Author: Toti Kadriu www.totiworks.com