Header menu logo fshafas

HafasClient Type

Instance members

Instance member Description

this.arrivals arg1 arg2

Full Usage: this.arrivals arg1 arg2

Parameters:
Returns: Promise<Arrivals>
Modifiers: abstract

Retrieves arrivals

arg0 : U4<string, Station, Stop, Location>
arg1 : DeparturesArrivalsOptions option
Returns: Promise<Arrivals>

this.departures arg1 arg2

Full Usage: this.departures arg1 arg2

Parameters:
Returns: Promise<Departures>
Modifiers: abstract

Retrieves departures

arg0 : U4<string, Station, Stop, Location>
arg1 : DeparturesArrivalsOptions option
Returns: Promise<Departures>

this.journeys arg1 arg2 arg3

Full Usage: this.journeys arg1 arg2 arg3

Parameters:
Returns: Promise<Journeys>
Modifiers: abstract

Retrieves journeys

arg0 : U4<string, Station, Stop, Location>
arg1 : U4<string, Station, Stop, Location>
arg2 : JourneysOptions option
Returns: Promise<Journeys>

this.journeysFromTrip arg1 arg2 arg3 arg4

Full Usage: this.journeysFromTrip arg1 arg2 arg3 arg4

Parameters:
Returns: Promise<Journeys>
Modifiers: abstract

Retrieves journeys from trip id to station

arg0 : string
arg1 : StopOver
arg2 : U4<string, Station, Stop, Location>
arg3 : JourneysFromTripOptions option
Returns: Promise<Journeys>

this.lines arg1 arg2

Full Usage: this.lines arg1 arg2

Parameters:
Returns: Promise<LinesWithRealtimeData>
Modifiers: abstract

Fetches all lines known to the HAFAS endpoint

arg0 : string
arg1 : LinesOptions option
Returns: Promise<LinesWithRealtimeData>

this.locations arg1 arg2

Full Usage: this.locations arg1 arg2

Parameters:
Returns: Promise<StationStopLocation array>
Modifiers: abstract

Retrieves locations or stops

arg0 : string
arg1 : LocationsOptions option
Returns: Promise<StationStopLocation array>

this.nearby arg1 arg2

Full Usage: this.nearby arg1 arg2

Parameters:
Returns: Promise<StationStopLocation array>
Modifiers: abstract

Retrieves nearby stops from location

arg0 : Location
arg1 : NearByOptions option
Returns: Promise<StationStopLocation array>

this.radar arg1 arg2

Full Usage: this.radar arg1 arg2

Parameters:
Returns: Promise<Radar>
Modifiers: abstract

Retrieves all vehicles currently in an area.

arg0 : BoundingBox
arg1 : RadarOptions option
Returns: Promise<Radar>

this.reachableFrom arg1 arg2

Full Usage: this.reachableFrom arg1 arg2

Parameters:
Returns: Promise<DurationsWithRealtimeData>
Modifiers: abstract

Retrieves stations reachable within a certain time from a location

arg0 : Location
arg1 : ReachableFromOptions option
Returns: Promise<DurationsWithRealtimeData>

this.refreshJourney arg1 arg2

Full Usage: this.refreshJourney arg1 arg2

Parameters:
Returns: Promise<JourneyWithRealtimeData>
Modifiers: abstract

refreshes a Journey

arg0 : string
arg1 : RefreshJourneyOptions option
Returns: Promise<JourneyWithRealtimeData>

this.remarks arg1

Full Usage: this.remarks arg1

Parameters:
Returns: Promise<WarningsWithRealtimeData>
Modifiers: abstract

Fetches all remarks known to the HAFAS endpoint

arg0 : RemarksOptions option
Returns: Promise<WarningsWithRealtimeData>

this.serverInfo arg1

Full Usage: this.serverInfo arg1

Parameters:
Returns: Promise<ServerInfo>
Modifiers: abstract

Fetches meta information from the HAFAS endpoint

arg0 : ServerOptions option
Returns: Promise<ServerInfo>

this.stop arg1 arg2

Full Usage: this.stop arg1 arg2

Parameters:
Returns: Promise<StationStopLocation>
Modifiers: abstract

Retrieves information about a stop

arg0 : U2<string, Stop>
arg1 : StopOptions option
Returns: Promise<StationStopLocation>

this.trip arg1 arg2

Full Usage: this.trip arg1 arg2

Parameters:
Returns: Promise<TripWithRealtimeData>
Modifiers: abstract

Refetch information about a trip

arg0 : string
arg1 : TripOptions option
Returns: Promise<TripWithRealtimeData>

this.tripsByName arg1 arg2

Full Usage: this.tripsByName arg1 arg2

Parameters:
Returns: Promise<TripsWithRealtimeData>
Modifiers: abstract

Retrieves trips by name.

arg0 : string
arg1 : TripsByNameOptions option
Returns: Promise<TripsWithRealtimeData>

Type something to start searching.