ScheduleDeliveryOptions

Options for scheduleDelivery.

import type { ScheduleDeliveryOptions } from "@northguild/gmt";

Members

Member	Type	Description
startTimeZone?	string	The time zone a zoneless first-leg departure is read in, an IANA name or a UTC offset to the minute (what isValidTimeZone accepts), for schedules published as local wall times. An ambiguous wall time resolves to the earlier instant and a nonexistent one to the later instant ("compatible"). Ignored when the first departure is already exact; never applied to later legs.

Definition

interface ScheduleDeliveryOptions {
  /**
   * The time zone a zoneless first-leg departure is read in, an IANA name or a UTC offset to the
   * minute (what `isValidTimeZone` accepts), for schedules published as local wall times. An
   * ambiguous wall time resolves to the earlier instant and a nonexistent one to the later instant
   * (`"compatible"`). Ignored when the first departure is already exact; never applied to later
   * legs.
   *
   * @defaultValue None. A zoneless first-leg departure is invalid input.
   */
  startTimeZone?: string;
}

Used by

• multimodalETA
• scheduleDelivery

Source

transport/calculate/scheduleDelivery.ts