EnturClient | @entur/sdk

Hierarchy

EnturClient

Properties

findTrips

findTrips: (from: string, to: string, date?: string | number | Date, options?: RequestOptions) => Promise<TripPattern[]>

Type declaration

- (from: string, to: string, date?: string | number | Date, options?: RequestOptions): Promise<TripPattern[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - from: string
  - to: string
  - Optional date: string | number | Date
  - Optional options: RequestOptions
  Returns Promise<TripPattern[]>

geocoder

geocoder: GeocoderClient

getBikeRentalStation

getBikeRentalStation: (stationId: string, options?: RequestOptions) => Promise<BikeRentalStation>

Type declaration

- (stationId: string, options?: RequestOptions): Promise<BikeRentalStation>
- Parameters
  - stationId: string
    
    The ID of the bike rental station in question
  - Optional options: RequestOptions
    
    RequestOptions
  Returns Promise<BikeRentalStation>

getBikeRentalStations

getBikeRentalStations: (stationIds: string[], options?: RequestOptions) => Promise<(undefined | BikeRentalStation)[]>

Type declaration

- (stationIds: string[], options?: RequestOptions): Promise<(undefined | BikeRentalStation)[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stationIds: string[]
  - Optional options: RequestOptions
  Returns Promise<(undefined | BikeRentalStation)[]>

getBikeRentalStationsByPosition

getBikeRentalStationsByPosition: (coordinates: Coordinates, distance?: number, options?: RequestOptions) => Promise<BikeRentalStation[]>

Type declaration

- (coordinates: Coordinates, distance?: number, options?: RequestOptions): Promise<BikeRentalStation[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - coordinates: Coordinates
  - distance: number = 500
  - Optional options: RequestOptions
  Returns Promise<BikeRentalStation[]>

getDeparturesBetweenStopPlaces

getDeparturesBetweenStopPlaces: (fromStopPlaceId: string, toStopPlaceId: string, params?: GetDeparturesBetweenStopPlacesParams, options?: RequestOptions) => Promise<Departure[]>

Type declaration

- (fromStopPlaceId: string, toStopPlaceId: string, params?: GetDeparturesBetweenStopPlacesParams, options?: RequestOptions): Promise<Departure[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - fromStopPlaceId: string
  - toStopPlaceId: string
  - params: GetDeparturesBetweenStopPlacesParams = {}
  - Optional options: RequestOptions
  Returns Promise<Departure[]>

getDeparturesForServiceJourney

getDeparturesForServiceJourney: (id: string, date?: string, options?: RequestOptions) => Promise<Departure[]>

Type declaration

- (id: string, date?: string, options?: RequestOptions): Promise<Departure[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - id: string
  - Optional date: string
  - Optional options: RequestOptions
  Returns Promise<Departure[]>

getDeparturesFromQuays

getDeparturesFromQuays: (quayIds: string[], params?: GetDeparturesParams, options?: RequestOptions) => Promise<(undefined | DeparturesById)[]>

Type declaration

- (quayIds: string[], params?: GetDeparturesParams, options?: RequestOptions): Promise<(undefined | DeparturesById)[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - quayIds: string[]
  - params: GetDeparturesParams = {}
  - Optional options: RequestOptions
  Returns Promise<(undefined | DeparturesById)[]>

getDeparturesFromStopPlace

getDeparturesFromStopPlace: (stopPlaceId: string, params?: GetDeparturesParams) => Promise<Departure[]>

Type declaration

- (stopPlaceId: string, params?: GetDeparturesParams): Promise<Departure[]>
- Finds departures that leaves from a certain StopPlace.
  
  deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceId: string
  - Optional params: GetDeparturesParams
  Returns Promise<Departure[]>

getDeparturesFromStopPlaces

getDeparturesFromStopPlaces: (stopPlaceIds: string[], params?: GetDeparturesParams, options?: RequestOptions) => Promise<(undefined | DeparturesById)[]>

Type declaration

- (stopPlaceIds: string[], params?: GetDeparturesParams, options?: RequestOptions): Promise<(undefined | DeparturesById)[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceIds: string[]
  - params: GetDeparturesParams = {}
  - Optional options: RequestOptions
  Returns Promise<(undefined | DeparturesById)[]>

getFeatures

getFeatures: (text: string, coords?: Coordinates, params?: GetFeaturesParams, options?: RequestOptions) => Promise<Feature[]>

Type declaration

- (text: string, coords?: Coordinates, params?: GetFeaturesParams, options?: RequestOptions): Promise<Feature[]>
- deprecated
  Use geocoder.autocomplete instead.
  
  Parameters
  - text: string
  - Optional coords: Coordinates
  - params: GetFeaturesParams = {}
  - Optional options: RequestOptions
  Returns Promise<Feature[]>

getFeaturesReverse

getFeaturesReverse: (coords: Coordinates, params?: GetFeaturesReverseParam, options?: RequestOptions) => Promise<Feature[]>

Type declaration

- (coords: Coordinates, params?: GetFeaturesReverseParam, options?: RequestOptions): Promise<Feature[]>
- deprecated
  Use geocoder.reverse instead.
  
  Parameters
  - coords: Coordinates
  - params: GetFeaturesReverseParam = {}
  - Optional options: RequestOptions
  Returns Promise<Feature[]>

getNearestPlaces

getNearestPlaces: (coordinates: Coordinates, params?: NearestParams, options?: RequestOptions) => Promise<NearestPlace[]>

Type declaration

- (coordinates: Coordinates, params?: NearestParams, options?: RequestOptions): Promise<NearestPlace[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - coordinates: Coordinates
  - params: NearestParams = {}
  - Optional options: RequestOptions
  Returns Promise<NearestPlace[]>

getParentStopPlace

getParentStopPlace: (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions) => Promise<undefined | StopPlaceDetails>

Type declaration

- (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions): Promise<undefined | StopPlaceDetails>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceId: string
  - params: StopPlaceParams = {}
  - Optional options: RequestOptions
  Returns Promise<undefined | StopPlaceDetails>

getQuaysForStopPlace

getQuaysForStopPlace: (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions) => Promise<Quay[]>

Type declaration

- (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions): Promise<Quay[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceId: string
  - params: StopPlaceParams = {}
  - Optional options: RequestOptions
  Returns Promise<Quay[]>

getStopPlace

getStopPlace: (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions) => Promise<undefined | StopPlaceDetails>

Type declaration

- (stopPlaceId: string, params?: StopPlaceParams, options?: RequestOptions): Promise<undefined | StopPlaceDetails>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceId: string
  - params: StopPlaceParams = {}
  - Optional options: RequestOptions
  Returns Promise<undefined | StopPlaceDetails>

getStopPlaceDepartures

getStopPlaceDepartures: () => void

Type declaration

- (): void
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Returns void

getStopPlaces

getStopPlaces: (stopPlaceIds: string[], params?: StopPlaceParams, options?: RequestOptions) => Promise<(undefined | StopPlaceDetails)[]>

Type declaration

- (stopPlaceIds: string[], params?: StopPlaceParams, options?: RequestOptions): Promise<(undefined | StopPlaceDetails)[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - stopPlaceIds: string[]
  - params: StopPlaceParams = {}
  - Optional options: RequestOptions
  Returns Promise<(undefined | StopPlaceDetails)[]>

getStopPlacesByPosition

getStopPlacesByPosition: (coordinates: Coordinates, distance?: number, params?: StopPlaceParams, options?: RequestOptions) => Promise<StopPlaceDetails[]>

Type declaration

- (coordinates: Coordinates, distance?: number, params?: StopPlaceParams, options?: RequestOptions): Promise<StopPlaceDetails[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - coordinates: Coordinates
  - distance: number = 500
  - params: StopPlaceParams = {}
  - Optional options: RequestOptions
  Returns Promise<StopPlaceDetails[]>

getTripPatterns

getTripPatterns: (params: GetTripPatternsParams, overrideConfig?: OverrideConfig, options?: RequestOptions) => Promise<TripPattern[]>

Type declaration

- (params: GetTripPatternsParams, overrideConfig?: OverrideConfig, options?: RequestOptions): Promise<TripPattern[]>
- deprecated
  The JourneyPlanner v2 queries and types are deprecated. Write your own GraphQL queries for JourneyPlanner v3. Write your own types or use those from JourneyPlannerTypes where applicable.
  
  Parameters
  - params: GetTripPatternsParams
  - Optional overrideConfig: OverrideConfig
  - Optional options: RequestOptions
  Returns Promise<TripPattern[]>

mobility

mobility: MobilityClient

nsr

nsr: NsrClient

Methods

queryJourneyPlanner

queryJourneyPlanner<T>(queryObj: string, variables: Record<string, unknown>, options?: RequestOptions): Promise<T>

- Defined in client.ts:42
Type parameters
- T
Parameters
- queryObj: string
- variables: Record<string, unknown>
- Optional options: RequestOptions
Returns Promise<T>

queryNsr

queryNsr<T>(queryObj: string, variables: Record<string, unknown>, options?: RequestOptions): Promise<T>

- Defined in client.ts:47
Type parameters
- T
Parameters
- queryObj: string
- variables: Record<string, unknown>
- Optional options: RequestOptions
Returns Promise<T>

Hierarchy

Index

Properties

Methods

Properties

findTrips

Type declaration

Parameters

from: string

to: string

Optional date: string | number | Date

Optional options: RequestOptions

Returns Promise<TripPattern[]>

geocoder

getBikeRentalStation

Type declaration

Parameters

stationId: string

Optional options: RequestOptions

Returns Promise<BikeRentalStation>

getBikeRentalStations

Type declaration

Parameters

stationIds: string[]

Optional options: RequestOptions

Returns Promise<(undefined | BikeRentalStation)[]>

getBikeRentalStationsByPosition

Type declaration

Parameters

coordinates: Coordinates

distance: number = 500

Optional options: RequestOptions

Returns Promise<BikeRentalStation[]>

getDeparturesBetweenStopPlaces

Type declaration

Parameters

fromStopPlaceId: string

toStopPlaceId: string

params: GetDeparturesBetweenStopPlacesParams = {}

Optional options: RequestOptions

Returns Promise<Departure[]>

getDeparturesForServiceJourney

Type declaration

Parameters

id: string

Optional date: string

Optional options: RequestOptions

Returns Promise<Departure[]>

getDeparturesFromQuays

Type declaration

Parameters

quayIds: string[]

params: GetDeparturesParams = {}

Optional options: RequestOptions

Returns Promise<(undefined | DeparturesById)[]>

getDeparturesFromStopPlace

Type declaration

Parameters

stopPlaceId: string

Optional params: GetDeparturesParams

Returns Promise<Departure[]>

getDeparturesFromStopPlaces

Type declaration

Parameters

stopPlaceIds: string[]

params: GetDeparturesParams = {}

Optional options: RequestOptions

Returns Promise<(undefined | DeparturesById)[]>

getFeatures

Type declaration

Parameters

text: string

Optional coords: Coordinates

params: GetFeaturesParams = {}

Optional options: RequestOptions

Returns Promise<Feature[]>

getFeaturesReverse

Type declaration

Parameters

coords: Coordinates