Interface JourneysOptionsCommon

interface JourneysOptionsCommon {
    accessibility?: string;
    arrival?: Date;
    bike?: boolean;
    departure?: Date;
    earlierThan?: string;
    entrances?: boolean;
    language?: string;
    laterThan?: string;
    polylines?: boolean;
    products?: Products;
    remarks?: boolean;
    results?: number;
    scheduledDays?: boolean;
    startWithWalking?: boolean;
    stopovers?: boolean;
    subStops?: boolean;
    tickets?: boolean;
    transferTime?: number;
    transfers?: number;
    via?: string;
    walkingSpeed?: string;
    when?: Date;
}

Properties

accessibility? arrival? bike? departure? earlierThan? entrances? language? laterThan? polylines? products? remarks? results? scheduledDays? startWithWalking? stopovers? subStops? tickets? transferTime? transfers? via? walkingSpeed? when?

Properties

Optional accessibility

accessibility?: string

'none', 'partial' or 'complete'

Default

none

Optional arrival

arrival?: Date

arrival date, departure and arrival are mutually exclusive.

Default

undefined

Optional bike

bike?: boolean

only bike-friendly journeys

Default

false

Optional departure

departure?: Date

departure date, undefined corresponds to Date.Now

Default

undefined

Optional earlierThan

earlierThan?: string

earlierThan, use Journeys#earlierRef, earlierThan and departure/arrival are mutually exclusive.

Default

undefined

Optional entrances

entrances?: boolean

parse & expose entrances of stops/stations?

Default

true

Optional language

language?: string

language to get results in

Default

en

Optional laterThan

laterThan?: string

laterThan, use Journeys#laterRef, laterThan and departure/arrival are mutually exclusive.

Default

undefined

Optional polylines

polylines?: boolean

return a shape for each leg?

Default

false

Optional products

products?: Products

Optional remarks

remarks?: boolean

parse & expose hints & warnings?

Default

true

Optional results

results?: number

how many search results?

Default

3

Optional scheduledDays

scheduledDays?: boolean

parse which days each journey is valid on

Default

false

Optional startWithWalking

startWithWalking?: boolean

start with walking

Default

false

Optional stopovers

stopovers?: boolean

return stations on the way?

Default

false

Optional subStops

subStops?: boolean

parse & expose sub-stops of stations?

Default

false

Optional tickets

tickets?: boolean

return tickets? only available with some profiles

Default

false

Optional transferTime

transferTime?: number

minimum time for a single transfer in minutes

Default

10

Optional transfers

transfers?: number

Maximum nr of transfers. Default: Let HAFAS decide.

Default

10

Optional via

via?: string

let journeys pass this station

Default

undefined

Optional walkingSpeed

walkingSpeed?: string

'slow', 'normal', 'fast'

Default

slow

Optional when

when?: Date

Deprecated

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc