Tonnenticker API Client

Ein TypeScript-Client für die Tonnenticker API zur Abfrage von Abfallterminen und weiteren Informationen.

Installation

npm install tonnenticker

Beschreibung

Diese Bibliothek bietet einen einfachen Zugang zur Tonnenticker API, mit der Informationen über Abfallentsorgungstermine, Städte, Straßen, Abfallfraktionen und mehr abgerufen werden können.

Verwendung

Client initialisieren

import Tonnenticker from 'tonnenticker';

const client = new Tonnenticker();

App-Daten abrufen

const appData = await client.getAppData();
console.log('Letzter Import:', appData.lastImport);

Abfallfraktionen abrufen

const fractions = await client.getFractions();
fractions.forEach((fraction) => {
  console.log(`${fraction.name} (ID: ${fraction.id}, Farbe: #${fraction.farbeRgb})`);
});

Städte/Orte abrufen

const cities = await client.getCities();
cities.forEach((city) => {
  console.log(`${city.name} (ID: ${city.id})`);
});

Straßen für eine Stadt abrufen

const cityId = '1'; // ID der gewünschten Stadt
const streets = await client.getStreets(cityId);
streets.forEach((street) => {
  console.log(`${street.name} (ID: ${street.id})`);
});

Abholtermine für eine Straße abrufen

const streetId = '1'; // ID der gewünschten Straße
const dates = await client.getCollectionDates(streetId);
dates.forEach((date) => {
  console.log(`Datum: ${date.datum}, Fraktion: ${date.bezirk.fraktion.name}`);
});

API Dokumentation

getAppData(): Promise<AppData>

Ruft Konfigurationsdaten der App ab.

Rückgabe: Ein Promise mit den App-Daten (Zeitpunkte für Alarme und E-Mails, letzter Import, etc.).

getFractions(): Promise<Fractions>

Ruft alle verfügbaren Abfallfraktionen ab.

Rückgabe: Ein Promise mit einem Array von Abfallfraktionen.

getCities(): Promise<Cities>

Ruft alle verfügbaren Städte/Orte ab.

Rückgabe: Ein Promise mit einem Array von Städten/Orten.

getStreets(cityId: string): Promise<Streets>

Ruft alle verfügbaren Straßen für eine bestimmte Stadt ab.

Parameter:

• cityId: ID der Stadt, für die Straßen abgerufen werden sollen

Rückgabe: Ein Promise mit einem Array von Straßen.

getCollectionDates(streetId: string): Promise<CollectionDates>

Ruft alle Abholtermine für eine bestimmte Straße ab.

Parameter:

• streetId: ID der Straße, für die Termine abgerufen werden sollen

Rückgabe: Ein Promise mit einem Array von Abholterminen mit zugehörigen Fraktionen.

Typen

Die Bibliothek exportiert folgende Typen für die Verwendung in Ihrer Anwendung:

import {AppData, City, Cities, Street, Streets, Fraction, Fractions, CollectionDate, CollectionDates} from 'tonnenticker';

Lizenz

MIT