TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias DepartArriveParams<Option>

    The departure or arrival time for route planning.

    It sets either when to depart from the origin or when to arrive at the destination. The routing engine then optimises the route for that time window, considering traffic patterns for that time of day.

    Traffic conditions vary significantly by:

    • Time of day (rush hour vs off-peak)
    • Day of week (weekday vs weekend)
    • Special events or holidays

    Specifying a departure or arrival time enables the router to:

    • Use appropriate traffic data for that time
    • Plan around rush hour or quiet periods
    • Calculate accurate arrival/departure times
    • Account for time-dependent road restrictions
    // Depart at specific time (morning commute)
    const departParams: DepartArriveParams = {
      option: 'departAt',
      date: new Date('2025-10-20T08:00:00+02:00')
    };

    // Arrive by specific time (catch a flight)
    const arriveParams: DepartArriveParams = {
      option: 'arriveBy',
      date: new Date('2025-10-20T14:00:00+02:00')
    };

    // Plan route avoiding rush hour
    const offPeakDepart: DepartArriveParams = {
      option: 'departAt',
      date: new Date('2025-10-20T10:30:00+02:00')  // After morning rush
    };
    type DepartArriveParams<Option extends DepartArriveOption = DepartArriveOption> = {
        date: Date;
        option: Option;
    }

    Type Parameters

    • Option extends DepartArriveOption = DepartArriveOption

      Whether this specifies departure or arrival time

    Index
    date option
    date: Date

    The date and time to depart or arrive.

    If you pass a past date, or one that is impossible to achieve (such as an imminent arrival date for a very long route), the route defaults to departing immediately.

    The date is an instant, sent in UTC. For a wall-clock time at the origin, build the Date with the origin's UTC offset.

    option: Option

    Whether to specify a departure or arrival time.

    • departAt calculates the route forward from this departure time.
    • arriveBy calculates the route backward to arrive by this time.

    Settings
    Member Visibility

    On This Page
    Properties