@dogame5/cvag-api v1.0.1

CVAG API

Ein TypeScript-Paket zur einfachen Interaktion mit der CVAG (Chemnitzer Verkehrs-AG) API. Es bietet Funktionen, um Haltestellen zu suchen, Stopps für bestimmte Haltestellen abzurufen und Haltestellen in einem definierten geografischen Bereich zu finden.

Features

• Suche nach Haltestellen basierend auf Straßennamen.
• Abrufen von Stopps für eine spezifische Haltestelle.
• Ermitteln von Haltestellen in einem geografischen Bereich (Latitude/Longitude)

Installation

Installiere das Paket mit npm:

> npm i cvag-api

Verwendung

Importieren des Moduls

import { CVAGAPI } from 'cvag-api';

const api = new CVAGAPI();

Beispiele

Haltestellen suchen

const stations = await api.searchStations("Zentrahlhaltestelle");
console.log(stations);

Stopps für eine spezifische Haltestelle abrufen

const stops = await api.getStops(stations[0].mandator, stations[0].number);
console.log(stops);

Haltestellen in einem geografischen Bereich finden

const stationsInArea = await api.getStationsInArea(0, 0, 100, 100);
console.log(stationsInArea);

API-Dokumentation

Klassen

CVAGAPI

searchStations(streetName: string): Promise<Station[]>

• Parameter: streetName (string) - Der Name der Straße, nach der gesucht werden soll.
• Rückgabewert: Liste von Station-Objekten.

getStops(mandator: string, number: number): Promise<Stop[]>

• Parameter:
  • mandator (string) - Mandant der Haltestelle (z.B. "CAG").
  • number (number) - Die Nummer der Haltestelle.
• Rückgabewert: Liste von Stop-Objekten.

getStationsInArea(minLat: number, maxLat: number, minLng: number, maxLng: number): Promise<Station[]>

• Parameter:
  • minLat, maxLat (number) - Breitengradbereich.
  • minLng, maxLng (number) - Längengradbereich.
• Rückgabewert: Liste von Station-Objekten.

Typen

Station

interface Station {
    mandator: string;
    number: number;
    displayName: string;
}

Stop

interface Stop {
    destination: string;
    serviceType: string;
    hasActualDeparture: boolean;
    actualDeparture: number;
    line: string;
    platform: string | null;
}

StationResponse

interface StationResponse {
    stations: Station[];
}

StopsResponse

interface StopsResponse {
    stops: Stop[];
}

Fehlerbehandlung

Alle Methoden verwenden try/catch, um Fehler bei API-Anfragen zu protokollieren. Stelle sicher, dass du bei der Verwendung der API-Methoden Fehler abfängst:

try {
    const stations = await api.searchStations("Musterstraße");
} catch (error) {
    console.error("Fehler beim Abrufen der Haltestellen:", error);
}

Lizenz

Dieses Projekt steht unter der MIT-Lizenz