Interface HafasClient

interface HafasClient {
    arrivals: ((station, options) => Promise<Arrivals>);
    departures: ((station, options) => Promise<Departures>);
    journeys: ((from, to, options) => Promise<Journeys>);
    journeysFromTrip?: ((fromTripId, previousStopover, to, opt) => Promise<Journeys>);
    lines?: ((query, opt) => Promise<LinesWithRealtimeData>);
    locations: ((name, options) => Promise<readonly (Location | Station | Stop)[]>);
    nearby: ((location, options) => Promise<readonly (Location | Station | Stop)[]>);
    radar?: ((box, options) => Promise<Radar>);
    reachableFrom?: ((address, options) => Promise<DurationsWithRealtimeData>);
    refreshJourney?: ((refreshToken, options) => Promise<JourneyWithRealtimeData>);
    remarks?: ((opt) => Promise<WarningsWithRealtimeData>);
    serverInfo: ((opt) => Promise<ServerInfo>);
    stop: ((id, options) => Promise<Location | Station | Stop>);
    trip?: ((id, options) => Promise<TripWithRealtimeData>);
    tripsByName?: ((lineNameOrFahrtNr, options) => Promise<TripsWithRealtimeData>);
}

Index

Properties

arrivals departures journeys journeysFromTrip? lines? locations nearby radar? reachableFrom? refreshJourney? remarks? serverInfo stop trip? tripsByName?

Properties

arrivals

arrivals: ((station, options) => Promise<Arrivals>)

Retrieves arrivals

Type declaration

- (station, options): Promise<Arrivals>
- Retrieves arrivals
  Parameters
  - station: string | Location | Station | Stop
    uid of station
  - options: undefined | DeparturesArrivalsOptions
    options
  Returns Promise<Arrivals>

Param: station

uid of station

Param: options

options

departures

departures: ((station, options) => Promise<Departures>)

Retrieves departures

Type declaration

- (station, options): Promise<Departures>
- Retrieves departures
  Parameters
  - station: string | Location | Station | Stop
    uid of station
  - options: undefined | DeparturesArrivalsOptions
    options
  Returns Promise<Departures>

Param: station

uid of station

Param: options

options

journeys

journeys: ((from, to, options) => Promise<Journeys>)

Retrieves journeys

Type declaration

- (from, to, options): Promise<Journeys>
- Retrieves journeys
  Parameters
  - from: string | Location | Station | Stop
    uid of station
  - to: string | Location | Station | Stop
    uid of station
  - options: undefined | JourneysOptions
    options
  Returns Promise<Journeys>

Param: from

uid of station

Param: to

uid of station

Param: options

options

`Optional` journeysFromTrip

journeysFromTrip?: ((fromTripId, previousStopover, to, opt) => Promise<Journeys>)

Retrieves journeys from trip id to station

Type declaration

- (fromTripId, previousStopover, to, opt): Promise<Journeys>
- Retrieves journeys from trip id to station
  Parameters
  - fromTripId: string
    id of trip
  - previousStopover: StopOver
    previous stopover
  - to: string | Location | Station | Stop
    uid of station or Station or Stop
  - opt: undefined | JourneysFromTripOptions
  Returns Promise<Journeys>

Param: fromTripId

id of trip

Param: previousStopover

previous stopover

Param: to

uid of station or Station or Stop

Param: options

options

`Optional` lines

lines?: ((query, opt) => Promise<LinesWithRealtimeData>)

Fetches all lines known to the HAFAS endpoint

Type declaration

- (query, opt): Promise<LinesWithRealtimeData>
- Fetches all lines known to the HAFAS endpoint
  Parameters
  - query: string
    string
  - opt: undefined | LinesOptions
    LinesOptions
  Returns Promise<LinesWithRealtimeData>

Param: query

string

Param: opt

LinesOptions

locations

locations: ((name, options) => Promise<readonly (Location | Station | Stop)[]>)

Retrieves locations or stops

Type declaration

- (name, options): Promise<readonly (Location | Station | Stop)[]>
- Retrieves locations or stops
  Parameters
  - name: string
    name of station
  - options: undefined | LocationsOptions
    options for search
  Returns Promise<readonly (Location | Station | Stop)[]>

Param: name

name of station

Param: options

options for search

nearby

nearby: ((location, options) => Promise<readonly (Location | Station | Stop)[]>)

Retrieves nearby stops from location

Type declaration

- (location, options): Promise<readonly (Location | Station | Stop)[]>
- Retrieves nearby stops from location
  Parameters
  - location: Location
    location
  - options: undefined | NearByOptions
    options for search
  Returns Promise<readonly (Location | Station | Stop)[]>

Param: location

location

Param: options

options for search

`Optional` radar

radar?: ((box, options) => Promise<Radar>)

Retrieves all vehicles currently in an area.

Type declaration

- (box, options): Promise<Radar>
- Retrieves all vehicles currently in an area.
  Parameters
  - box: BoundingBox
    area
  - options: undefined | RadarOptions
    options for search
  Returns Promise<Radar>

Param: box

area

Param: options

options for search

`Optional` reachableFrom

reachableFrom?: ((address, options) => Promise<DurationsWithRealtimeData>)

Retrieves stations reachable within a certain time from a location

Type declaration

- (address, options): Promise<DurationsWithRealtimeData>
- Retrieves stations reachable within a certain time from a location
  Parameters
  - address: Location
    location
  - options: undefined | ReachableFromOptions
    options for search
  Returns Promise<DurationsWithRealtimeData>

Param: address

location

Param: options

options for search

`Optional` refreshJourney

refreshJourney?: ((refreshToken, options) => Promise<JourneyWithRealtimeData>)

refreshes a Journey

Type declaration

- (refreshToken, options): Promise<JourneyWithRealtimeData>
- refreshes a Journey
  Parameters
  - refreshToken: string
    refreshToken must be a string, taken from journey#refreshToken
  - options: undefined | RefreshJourneyOptions
    options
  Returns Promise<JourneyWithRealtimeData>

Param: refreshToken

refreshToken must be a string, taken from journey#refreshToken

Param: options

options

`Optional` remarks

remarks?: ((opt) => Promise<WarningsWithRealtimeData>)

Fetches all remarks known to the HAFAS endpoint

Type declaration

- (opt): Promise<WarningsWithRealtimeData>
- Fetches all remarks known to the HAFAS endpoint
  Parameters
  - opt: undefined | RemarksOptions
    RemarksOptions
  Returns Promise<WarningsWithRealtimeData>

Param: opt

RemarksOptions

serverInfo

serverInfo: ((opt) => Promise<ServerInfo>)

Fetches meta information from the HAFAS endpoint

Type declaration

- (opt): Promise<ServerInfo>
- Fetches meta information from the HAFAS endpoint
  Parameters
  - opt: undefined | ServerOptions
    ServerOptions
  Returns Promise<ServerInfo>

Param: opt

ServerOptions

stop

stop: ((id, options) => Promise<Location | Station | Stop>)

Retrieves information about a stop

Type declaration

- (id, options): Promise<Location | Station | Stop>
- Retrieves information about a stop
  Parameters
  - id: string | Stop
    uid of station
  - options: undefined | StopOptions
    options for search
  Returns Promise<Location | Station | Stop>

Param: id

uid of station

Param: options

options for search

`Optional` trip

trip?: ((id, options) => Promise<TripWithRealtimeData>)

Refetch information about a trip

Type declaration

- (id, options): Promise<TripWithRealtimeData>
- Refetch information about a trip
  Parameters
  - id: string
    trip id, see Leg#tripId
  - options: undefined | TripOptions
    options
  Returns Promise<TripWithRealtimeData>

Param: id

trip id, see Leg#tripId

Param: name

name

Param: options

options

`Optional` tripsByName

tripsByName?: ((lineNameOrFahrtNr, options) => Promise<TripsWithRealtimeData>)

Retrieves trips by name.

Type declaration

- (lineNameOrFahrtNr, options): Promise<TripsWithRealtimeData>
- Retrieves trips by name.
  Parameters
  - lineNameOrFahrtNr: string
    string
  - options: undefined | TripsByNameOptions
    options for search
  Returns Promise<TripsWithRealtimeData>

Param: lineNameOrFahrtNr

string

Param: options

options for search

Interface HafasClient

Index

Properties

Properties

arrivals

Type declaration

Parameters

station: string | Location | Station | Stop

options: undefined | DeparturesArrivalsOptions

Returns Promise<Arrivals>

Param: station

Param: options

departures

Type declaration

Parameters

station: string | Location | Station | Stop

options: undefined | DeparturesArrivalsOptions

Returns Promise<Departures>

Param: station

Param: options

journeys

Type declaration

Parameters

from: string | Location | Station | Stop

to: string | Location | Station | Stop

options: undefined | JourneysOptions

Returns Promise<Journeys>

Param: from

Param: to

Param: options

Optional journeysFromTrip

Type declaration

Parameters

fromTripId: string

previousStopover: StopOver

to: string | Location | Station | Stop

opt: undefined | JourneysFromTripOptions

Returns Promise<Journeys>

Param: fromTripId

Param: previousStopover

Param: to

Param: options

Optional lines

Type declaration

Parameters

query: string

opt: undefined | LinesOptions

Returns Promise<LinesWithRealtimeData>

Param: query

Param: opt

locations

Type declaration

Parameters

name: string

options: undefined | LocationsOptions

Returns Promise<readonly (Location | Station | Stop)[]>

Param: name

Param: options

nearby

Type declaration

Parameters

location: Location

options: undefined | NearByOptions

Returns Promise<readonly (Location | Station | Stop)[]>

Param: location

Param: options

Optional radar

Type declaration

Parameters

box: BoundingBox

options: undefined | RadarOptions

Returns Promise<Radar>

Param: box

Param: options

Optional reachableFrom

Type declaration

Parameters

address: Location

options: undefined | ReachableFromOptions

Returns Promise<DurationsWithRealtimeData>

`Optional` journeysFromTrip

`Optional` lines

`Optional` radar

`Optional` reachableFrom

`Optional` refreshJourney

`Optional` remarks

`Optional` trip

`Optional` tripsByName