Merge pull request #10 from andaryjo/add-ticker

Add ticker

README.md

@@ -7,6 +7,7 @@ This client aims to be an easy to use and lightweight implementation for the pub
 The TRIAS Client currently only supports two basic functionalities:
 - Searching for stops (either using a name or coordinates).
 - Fetching departures for a stop.
+- Reading current ticker news for a stop.
 
 ## Usage
 

docs/README.md

@@ -24,7 +24,7 @@ This function returns a client that you can use to perform requests against a TR
 
 ## client.getStops(StopsRequestOptions options)
 
-This function returns a list of deparures for a given stop. It requires `StopsRequestOptions` and will return a Promise which resolves into a `StopsResult`.
+ This function returns a list of stops that fit the given search criteria. It requires `StopsRequestOptions` and will return a Promise which resolves into a `StopsResult`.
 
 | Paramater | Description | Type | Required | Default | Example |
 |---|---|---|---|---|---|
@@ -36,7 +36,7 @@ This function returns a list of deparures for a given stop. It requires `StopsRe
 
 ## client.getDepartures(DeparturesRequestOptions options)
 
-This function returns a list of stops that fit the given search criteria. It requires `DeparturesRequestOptions` and will return a Promise which resolves into a `DeparturesResult`.
+This function returns a list of departures and ticker information for a given stop. It requires `DeparturesRequestOptions` and will return a Promise which resolves into a `DeparturesResult`.
 
 | Paramater | Description | Type | Required | Default | Example |
 |---|---|---|---|---|---|

package.json

@@ -1,6 +1,6 @@
 {
     "name": "trias-client",
-    "version": "0.1.3",
+    "version": "0.2.0",
     "description": "Lean Node.js client for public transport TRIAS APIs.",
     "keywords": [
         "public-transport",

src/trias/TRIASDeparturesHandler.ts

@@ -123,6 +123,7 @@ export class TRIASDeparturesHandler {
                     const result: DeparturesResult = {
                         success: true,
                         departures,
+                        ticker
                     };
 
                     resolve(result);

src/types/results.ts

@@ -4,6 +4,7 @@ interface Result {
 
 interface DeparturesResult extends Result {
     departures?: FPTFStopover[];
+    ticker?: string[];
 }
 
 interface StopsResult extends Result {