Class ManniWatchApiClient

Hierarchy

ManniWatchApiClient

Index

Constructors

Properties

endpoint httpClient

Methods

getRouteByRouteId getRouteByTripId getRouteByVehicleId getSettings getStopInfo getStopLocations getStopPassages getStopPointInfo getStopPointLocations getStopPointPassages getTripPassages getVehicleLocations request

Constructors

constructor

new ManniWatchApiClient(endpoint: string, axiosInstance?: AxiosInstance): ManniWatchApiClient
Since
1.0.0
Parameters
- endpoint: string
  
  the endpoint base Url to query
- Optional axiosInstance: AxiosInstance
Returns ManniWatchApiClient
- Defined in manni-watch-api-client.ts:37

Properties

`Readonly` endpoint

endpoint: string

the endpoint base Url to query

`Private` `Readonly` httpClient

httpClient: AxiosInstance

Methods

getRouteByRouteId

getRouteByRouteId(routeId: string, direction: string): Promise<IVehiclePathInfo>
Since
3.0.0
Parameters
- routeId: string
  
  the route id
- direction: string
Returns Promise<IVehiclePathInfo>
- Defined in manni-watch-api-client.ts:115

getRouteByTripId

getRouteByTripId(tripId: string): Promise<IVehiclePathInfo>
Since
1.0.0
Parameters
- tripId: string
  
  tripId to query
Returns Promise<IVehiclePathInfo>
- Defined in manni-watch-api-client.ts:83

getRouteByVehicleId

getRouteByVehicleId(vehicleId: string): Promise<IVehiclePathInfo>
Since
1.0.0
Parameters
- vehicleId: string
  
  the vehicleId
Returns Promise<IVehiclePathInfo>
- Defined in manni-watch-api-client.ts:98

getSettings

getSettings(): Promise<ISettings>
Since
1.3.0

Returns Promise<ISettings>
- Defined in manni-watch-api-client.ts:265

getStopInfo

getStopInfo(stopId: string): Promise<IStopInfo>
Since
1.0.0
Parameters
- stopId: string
Returns Promise<IStopInfo>
- Defined in manni-watch-api-client.ts:240

getStopLocations

getStopLocations(box?: IBoundingBox): Promise<IStopLocations>
Since
1.4.0
Parameters
- box: IBoundingBox = ...
Returns Promise<IStopLocations>
- Defined in manni-watch-api-client.ts:132

getStopPassages

getStopPassages(stopId: string, mode?: StopMode, startTime?: number, timeFrame?: number): Promise<IStopPassage>
Since
2.3.0
Parameters
- stopId: string
- mode: StopMode = 'departure'
- Optional startTime: number
  
  milliseconds since epoch. now if undefined
- Optional timeFrame: number
  
  time frame from startTime in minutes
Returns Promise<IStopPassage>
- Defined in manni-watch-api-client.ts:194

getStopPointInfo

getStopPointInfo(stopPointId: string): Promise<IStopPointInfo>
Since
1.0.0
Parameters
- stopPointId: string
Returns Promise<IStopPointInfo>
- Defined in manni-watch-api-client.ts:254

getStopPointLocations

getStopPointLocations(box?: IBoundingBox): Promise<IStopPointLocations>
Since
1.4.0
Parameters
- box: IBoundingBox = ...
Returns Promise<IStopPointLocations>
- Defined in manni-watch-api-client.ts:153

getStopPointPassages

getStopPointPassages(stopPointId: string, mode?: StopMode, startTime?: number, timeFrame?: number): Promise<IStopPassage>
Since
3.0.0
Parameters
- stopPointId: string
- mode: StopMode = 'departure'
- Optional startTime: number
  
  milliseconds since epoch. now if undefined
- Optional timeFrame: number
  
  time frame from startTime in minutes
Returns Promise<IStopPassage>
- Defined in manni-watch-api-client.ts:216

getTripPassages

getTripPassages(tripId: string, mode?: StopMode): Promise<ITripPassages>
Since
1.0.0
Parameters
- tripId: string
- mode: StopMode = 'departure'
Returns Promise<ITripPassages>
- Defined in manni-watch-api-client.ts:174

getVehicleLocations

getVehicleLocations(positionType?: PositionType, lastUpdate?: string | number): Promise<IVehicleLocationList>
Correct
Parameters
- positionType: PositionType = 'CORRECTED'
  
  coordinate type
- Optional lastUpdate: string | number
  
  timestamp of last update
Returns Promise<IVehicleLocationList>
- Defined in manni-watch-api-client.ts:66

request

request<T, REQUEST_DATA>(reqOpts: AxiosRequestConfig<REQUEST_DATA>): Promise<T>
Type Parameters
- T
- REQUEST_DATA = any
Parameters
- reqOpts: AxiosRequestConfig<REQUEST_DATA>
Returns Promise<T>
- Defined in manni-watch-api-client.ts:51

Generated using TypeDoc