Planner | plannerjs - v0.4.1

Allows to ask route planning queries. Emits events defined in EventType

Hierarchy

Planner

Index

Constructors

constructor

Properties

Units

Methods

Constructors

constructor

new Planner(container?: Container): Planner

- Defined in src/planner/configurations/Planner.ts:77
Initializes a new Planner

Parameters
- Default value container: Container = defaultContainer
  
  The container of dependencies we are working with
Returns Planner

Properties

Static Units

Units: Units = Units

Methods

addCatalogSource

addCatalogSource(accessUrl: string): Promise<void>

- Defined in src/planner/configurations/Planner.ts:116
Parameters
- accessUrl: string
Returns Promise<void>

addConnectionSource

addConnectionSource(accessUrl: string, travelMode?: TravelMode): void

- Defined in src/planner/configurations/Planner.ts:100
Parameters
- accessUrl: string
- Default value travelMode: TravelMode = TravelMode.Train
Returns void

addStopSource

addStopSource(accessUrl: string): void

- Defined in src/planner/configurations/Planner.ts:104
Parameters
- accessUrl: string
Returns void

completePath

completePath(path: IPath): Promise<IPath>

- Defined in src/planner/configurations/Planner.ts:133
Parameters
- path: IPath
Returns Promise<IPath>

getAllStops

getAllStops(): Promise<IStop[]>

- Defined in src/planner/configurations/Planner.ts:247
Returns Promise<IStop[]>

getConnectionSources

getConnectionSources(): IConnectionsSourceConfig[]

- Defined in src/planner/configurations/Planner.ts:108
Returns IConnectionsSourceConfig[]

getStopsSources

getStopsSources(): IStopsSourceConfig[]

- Defined in src/planner/configurations/Planner.ts:112
Returns IStopsSourceConfig[]

prefetchConnections

prefetchConnections(from: Date, to: Date): void

- Defined in src/planner/configurations/Planner.ts:233
Parameters
- from: Date
- to: Date
Returns void

prefetchStops

prefetchStops(): void

- Defined in src/planner/configurations/Planner.ts:224
Returns void

query

query(query: IQuery): AsyncIterator<IPath>

- Defined in src/planner/configurations/Planner.ts:190
Given an IQuery, it will evaluate the query and return a promise for an AsyncIterator of IPath instances

Parameters
- query: IQuery
  
  An IQuery specifying a route planning query
Returns AsyncIterator<IPath>

An AsyncIterator of IPath instances

resolveLocation

resolveLocation(id: string): Promise<ILocation>

- Defined in src/planner/configurations/Planner.ts:260
Parameters
- id: string
Returns Promise<ILocation>

setDevelopmentProfile

setDevelopmentProfile(blob: object): Promise<this>

- Defined in src/planner/configurations/Planner.ts:237
Parameters
- blob: object
Returns Promise<this>

setProfileID

setProfileID(profileID: string): this

- Defined in src/planner/configurations/Planner.ts:242
Parameters
- profileID: string
Returns this

Generated using TypeDoc