JSPM

metro-api-client

3.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q20381F
  • License CC-BY-SA-4.0

A client library for my Tyne and Wear Metro API proxy and data aggregator.

Package Exports

  • metro-api-client

Readme

metro-api-client

A client library for my Tyne and Wear Metro API proxy and data aggregator.

Installation

npm install metro-api-client
# or
yarn add metro-api-client
# or
pnpm add metro-api-client

Basic Usage

import { MetroApiClient } from 'metro-api-client';

const baseUrl = 'http://localhost:3000/api'; // Replace with your proxy API URL
const client = new MetroApiClient(baseUrl);

// Example: Fetch all active trains
const trains = await client.getTrains();
console.log(trains.trains);

// Example: Stream updates to a specific train
client.streamNewTrainHistory("121", {
    onNewHistoryEntry: (data) => {
        console.log(data);
    }
})