# emt-bus

> Library that works a layer over the emt API service

Latest version **1.0.8** (published 2018-07-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install emt-bus
pnpm add emt-bus
yarn add emt-bus
bun add emt-bus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2018-07-19 |
| First published | 2017-11-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 74.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | lorenzo Gamboa |
| Maintainers | lgamboa |
| Keywords | library, madrid, public, transport, api |

## Links

- npm: https://www.npmjs.com/package/emt-bus
- npm.io page: https://npm.io/package/emt-bus

## Dependencies (3)

- [dotenv](https://npm.io/package/dotenv.md) ^4.0.0
- [request](https://npm.io/package/request.md) ^2.83.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2018-07-19
- 1.0.7 — 2018-07-17
- 1.0.6 — 2018-07-16
- 1.0.5 — 2018-07-16
- 1.0.4 — 2018-07-15
- 1.0.3 — 2017-12-06
- 1.0.2 — 2017-12-03
- 1.0.1 — 2017-11-29
- 1.0.0 — 2017-11-27

## README

# EMT-library

![Alt text](/assets/emt-bus_logo.png "Title")

<a href="https://snyk.io/test/github/lorengamboa/emt-bus">
<img  src="https://snyk.io/test/github/lorengamboa/emt-bus/badge.svg"></a>

+ Requirements
+ How to install
+ How to use
    - Authentication
    - Select a category
    - Make a request
+ Category methods
    - Bus
    - Geo
    - Media
    - Bike
    - Parking

## Requirements
> Node.js >= v6

## How to install
>npm install emt-bus --save

## How to use

**Import and authenticate against the API.**
```javascript
var EMT = require('emt-bus').('<idClient>', '<passKey>');
```
**Select a an API category**
```javascript
var bus = EMT('bus');
```
**Finally, make the request by selecting a method that corresponds to its category**
```javascript
bus.getListLines({ Lines: '721', SelectDate: '09/09/1993' }).then ..
```

**Response**
<code>
</code>

### 🚌 Bus Methods 

|   Methods|Description |
| ---------|-------------|
| getCalendar|Get EMT Calendar for all days and line schedules for a range of dates   
| getGroups|Returns every line type and their details |
| getListLines|Returns lines with description and groups     |
| getNodesLines|Returns all stop identifiers and his coordinate, name, lines and directions|
| getRouteLines| Returns a line/s route with the vertex info to build the route and coordinates for stops and axes |
| getTimeTableLines|Provices information about the requested line at travel time|
| getTimesLines|Returns current schedules for the requested lines|

### 🌍 Geo Methods 

|   Methods|Description |
| ---------|-------------|
| getArriveStop|Gets bus arrive info to a target stop |
| getGroups|Return a list of groups |
| getInfoLine|Returns line info in a target date|
| getInfoLineExtend|Returns line info in a target date|
| getPointsOfInterest|Returns a list of Points of Interest from a coordinate center with a target radius|
| getPointsOfInterestTypes|Returns a list of Point of interest types|
| getStopsFromStop|Returns a list of stops from a target stop with a target radius and the lines arriving to those stops.|
| getStopsFromXY|Returns a list of stops from a coordinate with a radius and the lines arriving to those stops.|
| getStopsLine|Provices information about the requested line at travel time.|
| getStreet|Returns a list of EMT nodes related to a location. All EMT locations are a group of stops  within a target radius and the lines related to each stop in the list.|
| getStreetFromXY|Returns a list of stops from a target coordinate.|

### 📺 Media Methods(WIP)

|   Methods|Description |
| ---------|-------------|
| getEstimatesIncident| Get estimate arrival time to stop and its related issues
| getStreetRoute|Request up to three optimal routes from one place to another using bus or walking, source and destination must be in a format known for the system, which means that should have been validated by a GetStreet call   
| getRouteWithAlarm| |
| getRouteWithAlarmResponse| |
| getRoute| |
| getRouteResponse| |

### 🚲 Bike Methods 

|   Methods|Description |
| ---------|-------------|
| getStations|Obtiene la relación de todas las bases de Bicimad y su estado operacional. |
| getSingleStations|Obtiene la información de una base |

### 🅿 Parking Methods (WIP)

|   Methods|Description |
| ---------|-------------|
| detailParking|N/A |
| detailPOI|N/A |
| iconDescription|N/A|
| infoParkingPoi|N/A|
| listFeatures|N/A|
| listParking|N/A|
| listStreetPoisParking|N/A|
| listTypesPOIs|N/A|

---
_Source: https://npm.io/package/emt-bus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
