1. Home
  2. Classes
  3. TripSearchResult

new TripSearchResult( segments )

Description

Trip Search Result

This Class represents a single Trip Search Result. It consists of one or more Trip Search Result Segments, which are the individual Trips a rider would take to get from their original Origin Stop to their final Destination Stop.

Module: search/TripSearchResult

Parameters
Name Type Description
segments TripSearchResultSegment | Array.<TripSearchResultSegment>

Trip Search Result Segment(s)
Details

search/TripSearchResult.js, line 27

Members

segments :Array.<TripSearchResultSegment>

Description

The Trip Search Result Segments

Details
Array.<TripSearchResultSegment>

search/TripSearchResult.js, line 44

length :int

Description

The number of Trip Search Result Segments in this Result

Details
int

search/TripSearchResult.js, line 50

origin :StopTime

Description

The StopTime of the Trip Search's Origin Stop

Details
StopTime

search/TripSearchResult.js, line 56

destination :StopTime

Description

The StopTime of the Trip Search's Destination Stop

Details
StopTime

search/TripSearchResult.js, line 62

travelTime :int

Description

Total Travel Time (in minutes) - includes all segments and layovers

Details
int

search/TripSearchResult.js, line 68

transfers :Array.<TripSearchResultTransfer>

Description

List of Transfers

Details
Array.<TripSearchResultTransfer>

search/TripSearchResult.js, line 74

Methods

<static> sortByDeparture( a, b ) → {number}

Description

Sort Trip Search Results by their departure from the Origin

Parameters
Name Type Description
a TripSearchResult

first TripSearchResult
b TripSearchResult

second TripSearchResult
Returns

compare integer

Details

search/TripSearchResult.js, line 119