{"_id":"@dogame5/cvag-api","_rev":"1-006bac78fc27b9b848b20e2ae5617982","name":"@dogame5/cvag-api","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@dogame5/cvag-api","version":"1.0.0","author":{"name":"DoGame5"},"license":"ISC","_id":"@dogame5/cvag-api@1.0.0","maintainers":[{"name":"dogame5","email":"dahtedominik@gmail.com"}],"dist":{"shasum":"5b942664c906379c6295a2bd061b179496321326","tarball":"https://registry.npmjs.org/@dogame5/cvag-api/-/cvag-api-1.0.0.tgz","fileCount":15,"integrity":"sha512-ok5jydRZIAuavY+jurMWDRUT06v97hZKTdWeZCoQjJhG9aLnKnLx22E/GNi1sjXf3yCY+Dx5X1WfRRTxsq+6Vg==","signatures":[{"sig":"MEQCIFpSp1/2wlLhSZDCQMztT8fRgXP5aj+nkbJm04eniQJWAiA7d+rW+q4WDehFoPizhdq5RGAWl6NfbNbn4lVSkQmORQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":12999},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"c4d1e6bfc3d0b44aafb7c0777c007092c0995427","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc"},"_npmUser":{"name":"dogame5","email":"dahtedominik@gmail.com"},"_npmVersion":"10.8.2","description":"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.","directories":{},"_nodeVersion":"20.17.0","_hasShrinkwrap":false,"devDependencies":{"axios-cache-adapter":"^2.7.3"},"_npmOperationalInternal":{"tmp":"tmp/cvag-api_1.0.0_1732985739602_0.5300399724598599","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@dogame5/cvag-api","version":"1.0.1","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"DoGame5"},"license":"MIT","description":"An api for the Chemnitzer Verkehrs-AG","devDependencies":{"axios-cache-adapter":"^2.7.3"},"keywords":["cvag","api","chemnitz","transport","tram","bus"],"_id":"@dogame5/cvag-api@1.0.1","gitHead":"c4d1e6bfc3d0b44aafb7c0777c007092c0995427","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-qMAmy5Suzd8jAn9NeF34NuWx/patXiDx9Gl3WCWsuO7C+uT5KKs4nu4fvH6izTSIpsemf+JrPhEIS3KDGrJJ6Q==","shasum":"b4226129b34e5ec1a0296c9c259a9a1b1ec4b1d4","tarball":"https://registry.npmjs.org/@dogame5/cvag-api/-/cvag-api-1.0.1.tgz","fileCount":15,"unpackedSize":13107,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCMqet+TVktSYy5HesCnmDOKPmhJMY0MH3zj87N69MPlgIhAL8ahBZW93PRS+BMDny4khKz61tYIXHJyQNabjuipoKB"}]},"_npmUser":{"name":"dogame5","email":"dahtedominik@gmail.com"},"directories":{},"maintainers":[{"name":"dogame5","email":"dahtedominik@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cvag-api_1.0.1_1732985943667_0.7364175900347982"},"_hasShrinkwrap":false}},"time":{"created":"2024-11-30T16:55:39.533Z","modified":"2024-11-30T16:59:04.101Z","1.0.0":"2024-11-30T16:55:39.781Z","1.0.1":"2024-11-30T16:59:03.888Z"},"author":{"name":"DoGame5"},"license":"MIT","description":"An api for the Chemnitzer Verkehrs-AG","maintainers":[{"name":"dogame5","email":"dahtedominik@gmail.com"}],"readme":"# CVAG API\r\n\r\nEin 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.\r\n\r\n## Features\r\n\r\n- **Suche nach Haltestellen** basierend auf Straßennamen.\r\n- **Abrufen von Stopps** für eine spezifische Haltestelle.\r\n- **Ermitteln von Haltestellen in einem geografischen Bereich** (Latitude/Longitude)\r\n\r\n## Installation\r\n\r\nInstalliere das Paket mit npm:\r\n\r\n```bash\r\n> npm i cvag-api\r\n```\r\n\r\n## Verwendung\r\n**Importieren des Moduls**\r\n```typescript\r\nimport { CVAGAPI } from 'cvag-api';\r\n\r\nconst api = new CVAGAPI();\r\n```\r\n\r\n## Beispiele\r\n**Haltestellen suchen**\r\n```typescript\r\nconst stations = await api.searchStations(\"Zentrahlhaltestelle\");\r\nconsole.log(stations);\r\n```\r\n**Stopps für eine spezifische Haltestelle abrufen**\r\n```typescript\r\nconst stops = await api.getStops(stations[0].mandator, stations[0].number);\r\nconsole.log(stops);\r\n```\r\n**Haltestellen in einem geografischen Bereich finden**\r\n```typescript\r\nconst stationsInArea = await api.getStationsInArea(0, 0, 100, 100);\r\nconsole.log(stationsInArea);\r\n```\r\n\r\n# API-Dokumentation\r\n\r\n## Klassen\r\n`CVAGAPI`\r\n\r\n`searchStations(streetName: string): Promise<Station[]>`\r\n\r\n- **Parameter:** `streetName` (string) - Der Name der Straße, nach der gesucht werden soll.\r\n- **Rückgabewert:** Liste von `Station`-Objekten.\r\n\r\n`getStops(mandator: string, number: number): Promise<Stop[]>`\r\n\r\n- **Parameter:**\r\n  - `mandator` (string) - Mandant der Haltestelle (z.B. \"CAG\").\r\n  - `number` (number) - Die Nummer der Haltestelle.\r\n- **Rückgabewert:** Liste von `Stop`-Objekten.\r\n\r\n`getStationsInArea(minLat: number, maxLat: number, minLng: number, maxLng: number): Promise<Station[]>`\r\n\r\n- **Parameter:**\r\n  - `minLat`, `maxLat` (number) - Breitengradbereich.\r\n  - `minLng`, `maxLng` (number) - Längengradbereich.\r\n- **Rückgabewert:** Liste von `Station`-Objekten.\r\n\r\n## Typen\r\n`Station`\r\n\r\n```typescript\r\ninterface Station {\r\n    mandator: string;\r\n    number: number;\r\n    displayName: string;\r\n}\r\n```\r\n\r\n`Stop`\r\n\r\n```typescript\r\ninterface Stop {\r\n    destination: string;\r\n    serviceType: string;\r\n    hasActualDeparture: boolean;\r\n    actualDeparture: number;\r\n    line: string;\r\n    platform: string | null;\r\n}\r\n```\r\n\r\n`StationResponse`\r\n\r\n```typescript\r\ninterface StationResponse {\r\n    stations: Station[];\r\n}\r\n```\r\n\r\n`StopsResponse`\r\n\r\n```typescript\r\ninterface StopsResponse {\r\n    stops: Stop[];\r\n}\r\n```\r\n\r\n# Fehlerbehandlung\r\nAlle Methoden verwenden `try/catch`, um Fehler bei API-Anfragen zu protokollieren. Stelle sicher, dass du bei der Verwendung der API-Methoden Fehler abfängst:\r\n\r\n```typescript\r\ntry {\r\n    const stations = await api.searchStations(\"Musterstraße\");\r\n} catch (error) {\r\n    console.error(\"Fehler beim Abrufen der Haltestellen:\", error);\r\n}\r\n```\r\n\r\n# Lizenz\r\nDieses Projekt steht unter der MIT-Lizenz\r\n","readmeFilename":"README.md","keywords":["cvag","api","chemnitz","transport","tram","bus"]}