tfl-api-wrapper
TypeScript icon, indicating that this package has built-in type declarations

1.7.3 • Public • Published

TfL Logo

TfL API Wrapper

A NodeJS wrapper for the TfL Unified API, made with TypeScript.

Read the Documentation

Language grade: JavaScript CI NPM Version Issues Gitpod ready-to-code

Installation

npm install tfl-api-wrapper
yarn add tfl-api-wrapper

Contribute

There are many ways to contribute to this repo.

Example Usage

Async... await

import { StopPoint } from 'tfl-api-wrapper';

const app_key = 'API KEY HERE'; // Use an environment file
const stopPoint = new StopPoint(app_key)

const arrivals = await stopPoint.getStationArrivals('940GZZLUKSX');
console.log(arrivals);

Callback

import { StopPoint } from 'tfl-api-wrapper';

const app_key = 'API KEY HERE'; // Use an environment file
const stopPoint = new StopPoint(app_key)

stopPoint.getStationArrivals('940GZZLUKSX').then((arrivals) => {
    console.log(arrivals)
});

Disclaimer

This repository is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Transport for London (TfL) or its parent organisation Greater London Authority (GLA)

Package Sidebar

Install

npm i tfl-api-wrapper

Weekly Downloads

1

Version

1.7.3

License

ISC

Unpacked Size

171 kB

Total Files

63

Last publish

Collaborators

  • zackaryh8