Package Exports
- @hasadna/open-bus-api-client
- @hasadna/open-bus-api-client/dist/esm/index.js
- @hasadna/open-bus-api-client/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hasadna/open-bus-api-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
π Open Bus API Client
A TypeScript client library for interacting with the Open-Bus API.
π’ Get Involved
- π¬ For general help and system updates, join the Hasadna Slack: #open-bus channel
- π Found a bug or have a feature request? Open an issue
- π€ Want to contribute? See our contributing guidelines
π Related Projects
- πΊοΈ Open Bus Map Search (Client App) - Live Website
- π¦ Open Bus API Client (API Package Generator)
- π Open Bus Stride API (REST) β API Docs
- π Open Bus Backend (REST) β API Docs
π¦ Installation
npm install @hasadna/open-bus-api-clientπ§ Usage
import {
AggregationsApi,
ComplaintsApi,
Configuration,
GovernmentTransportationApi,
GtfsApi,
HealthApi,
IssuesApi,
SiriApi,
UserCasesApi,
} from '@hasadna/open-bus-api-client'
// URL: https://open-bus-stride-api.hasadna.org.il
export const STRIDE_API_BASE_PATH = process.env.VITE_STRIDE_API
const STRIDE_API_CONFIG = new Configuration({ basePath: STRIDE_API_BASE_PATH })
export const AGGREGATIONS_API = new AggregationsApi(STRIDE_API_CONFIG)
export const GTFS_API = new GtfsApi(STRIDE_API_CONFIG)
export const SIRI_API = new SiriApi(STRIDE_API_CONFIG)
export const USER_CASE_API = new UserCasesApi(STRIDE_API_CONFIG)
// URL: https://open-bus-backend.k8s.hasadna.org.il
const BACKEND_API_BASE_PATH = process.env.VITE_BACKEND_API
const BACKEND_API_CONFIG = new Configuration({ basePath: BACKEND_API_BASE_PATH })
export const HEALTH_API = new HealthApi(BACKEND_API_CONFIG)
export const ISSUES_API = new IssuesApi(BACKEND_API_CONFIG)
export const COMPLAINTS_API = new ComplaintsApi(BACKEND_API_CONFIG)
export const GOVERNMENT_TRANSPORTATION_API = new GovernmentTransportationApi(BACKEND_API_CONFIG)
const stops = await GTFS_API.gtfsRideStopsListGet(...)
console.log(stops);