Skip to content
@northguild/gmt

Types

Shared types

Section titled “Shared types”
  • BusinessCalendar: A jurisdiction’s working week: which weekdays are weekend, which dates are holidays, and which locality the answer is for.
  • CalendarOptions: Core fields shared by all calendar-formatting interfaces.
  • CalendarSystem: A calendar GMT’s calendar functions support, named by its canonical calendar id: the CLDR common/bcp47/calendar.xml type that Temporal’s CanonicalizeCalendar returns, and that RFC 9557’s [u-ca=<id>] annotation carries.
  • CutoffOptions: Options for cutoffAt.
  • DateCycleField: A date field cycleDate, cycleDateTime and cycleZoned can step and wrap: "year", "month" or "day".
  • DateDurationUnit: A date field of an ISO 8601 duration, in the plural: "years", "months", "weeks" or "days".
  • DateTimeCycleField: A date or time field cycleDateTime and cycleZoned can step and wrap: any DateCycleField or TimeCycleField.
  • DateTimeDurationUnit: Any field of an ISO 8601 duration, in the plural, from "years" down to "nanoseconds".
  • DateTimeFormatOptions: Options accepted by date/time formatting functions that delegate to Intl.DateTimeFormat (via Temporal’s .toLocaleString() or TemporalIntl.DateTimeFormat).
  • DateTimeUnit: A date or time unit in the singular, from "year" down to "nanosecond", as Temporal’s rounding and difference options name units.
  • DateUnit: A date unit in the singular: "year", "month", "week" or "day", as Temporal’s rounding and difference options name units.
  • Disambiguation: How a local wall time that a time zone’s clock shows twice or never is resolved to an instant, as Temporal’s disambiguation option (Temporal.ZonedDateTime.from(item, { disambiguation })).
  • DurationRelativeTo: The anchor a calendar-unit duration operation is measured from, as Temporal’s relativeTo option takes it (Duration.prototype.round, Duration.prototype.total, Duration.compare).
  • DurationStringOptions: Precision options for the ISO 8601 duration string a diff*AsDuration function writes, passed to Temporal.Duration.prototype.toString().
  • EdiDatePeriod: A period between two calendar dates, as a UN/EDIFACT period (718) or an X12 range (RD8, RD) states it: the result of parseEdifactDatePeriod and parseX12DateRange.
  • EdiDateTimePeriod: A period between two local date-times, as a UN/EDIFACT period (719) or an X12 range (RDT, DTS) states it: the result of parseEdifactDateTimePeriod and parseX12DateTimeRange.
  • EdifactDateFormat: The UN/EDIFACT data element 2379 (Date or time or period format code) value that states a calendar date.
  • EdifactDatePeriodFormat: The UN/EDIFACT data element 2379 value that states a period between two calendar dates.
  • EdifactDateTimeFormat: The UN/EDIFACT data element 2379 values that state a date and a time with no offset: a local time at a place the value does not name.
  • EdifactDateTimePeriodFormat: The UN/EDIFACT data element 2379 value that states a period between two local date-times.
  • EdifactOffsetDateTimeFormat: The UN/EDIFACT data element 2379 values that state a date and a time with an offset from UTC.
  • EdifactTimeFormat: The UN/EDIFACT data element 2379 values that state a time of day with no date and no offset.
  • EpcisEventTime: The two time fields every GS1 EPCIS 2.0 (ISO/IEC 19987) event must carry.
  • ExcelDateSystem: Which Excel date system a serial belongs to.
  • FiscalPattern: Week-per-period shape of a 52/53-week fiscal year, one entry per month of a quarter.
  • FractionalDigit: How many fractional-second digits an ISO string is written with, as Temporal’s fractionalSecondDigits option of toString().
  • FreeTimeBasis: How days are counted: every local calendar day, or only the terminal’s working days.
  • FreeTimeFirstDay: Whether the day of the triggering event is free day one ("eventDay"), or free time starts on the following counted day ("nextDay").
  • FreeTimeOptions: The tariff terms a free-time count needs.
  • Interval: A span of time between two ISO 8601 instant strings, half-open: [start, end).
  • IsoWeekday: An ISO weekday number: 1 (Monday) through 7 (Sunday), as Temporal.PlainDate#dayOfWeek reads it.
  • Leg: One leg of a multi-modal journey: a departure, how long it takes, and where it lands.
  • LocaleNameStyle: The calendar-name styles supported by GMT’s locale name lookups.
  • LocalWindow: A daily window of local wall time, half-open: open from from up to (not including) to.
  • Offset: What to do when the UTC offset written in a zoned value disagrees with its time zone, as Temporal’s offset option (Temporal.ZonedDateTime.prototype.with(item, { offset })).
  • OffsetInstant: An absolute instant paired with the local UTC offset in force where the event happened.
  • OperatingOverride: One local date whose windows differ from the weekly pattern.
  • OperatingSchedule: Weekly opening hours in one zone, with dated exceptions.
  • Overflow: What to do when a date or time field is out of range, as Temporal’s overflow option (Temporal.PlainDate.prototype.add(item, { overflow })).
  • PunctualityTolerance: The caller’s punctuality tolerance, as ISO 8601 durations of exact time (a day is 24 hours; years, months and weeks are refused; neither may be negative).
  • RelativeRoundingMethod: How the formatRelative* functions round a fractional distance to a whole number of the unit displayed.
  • RelativeTimeFormatOptions: Core fields shared by all relative-time formatting interfaces.
  • RelativeUnit: Canonical 7-member unit for Intl.RelativeTimeFormat and Temporal since/until totals, excluding quarter.
  • RollConvention: What rollDate does when a date lands on a non-business day.
  • RoundingOptions: How a difference is rounded, as the rounding options of Temporal’s until() and since() (Temporal.PlainDate.prototype.until(other, options)).
  • ScheduleDeliveryOptions: Options for scheduleDelivery.
  • TimeCycleField: A time field cycleTime, cycleDateTime and cycleZoned can step and wrap, from "hour" down to "nanosecond": the fields of Temporal’s PlainTime.
  • TimeDurationUnit: A time field of an ISO 8601 duration, in the plural, from "hours" down to "nanoseconds".
  • TimestampClass: What a transport timestamp claims to be, in DCSA’s eventClassifierCode vocabulary:
  • TimestampEvent: One recorded timestamp of an event: what it claims, when it claims it, and when that claim was recorded.
  • TwoDigitYearOptions: How a two-digit year (yy in a pattern, YYMMDD in an EDI value) gets its century.
  • UnixUnit: Unit accepted by epochUnit in unix-epoch functions.
  • X12DateFormat: The X12 data element 1250 (Date Time Period Format Qualifier) values that state a calendar date.
  • X12DateRangeFormat: The X12 data element 1250 values that state a range between two calendar dates, transmitted with its hyphen.
  • X12DateTimeFormat: The X12 data element 1250 values that state a date and a time with no offset: a local time at a place the value does not name.
  • X12DateTimeRangeFormat: The X12 data element 1250 values that state a range between two local date-times, transmitted with its hyphen.
  • X12OffsetTimeCode: The 31 X12 data element 623 time codes that state an offset from UTC, the codes x12TimeCodeOffset reads.
  • X12TimeFormat: The X12 data element 1250 values that state a time of day.
  • X12ZoneTimeCode: The 25 X12 data element 623 time codes that name a zone and state no offset, the codes x12TimeCodeZone reads.
  • ZoneBucketUnit: Units floorToZone and bucketRange floor an instant to, in a target time zone.

Documented with their function

Section titled “Documented with their function”
  • BillingDates: The dates a billing timeline is counted from: the anchor, and the invoice and request once they exist.
  • BillingDeadlines: What billingTimeline returns: each deadline as an ISO date, and each comparison once its date exists.
  • BillingWindows: The three windows the caller supplies, in calendar days, none defaulted, and an optional agreed resolution date.
  • BillOfLadingEvent: Which date on a bill of lading a value is rendered for, one per dated field of the DCSA Bill of Lading 3.0 TransportDocument:
  • BolTimestampOptions: Options for bolTimestamp.
  • ClassifiedTimestamp: What bestAvailable returns: the chosen timestamp and the class it carries.
  • ClockDirection: Which leg of the container’s cycle the clock is on.
  • ClockEvent: A container event: what happened and the instant it happened.
  • ClockEventType: The events a container’s charging clocks run between, named after the DCSA Track & Trace equipment events they correspond to (equipmentEventTypeCode with emptyIndicatorCode):
  • ClockOptions: The options demurrageClock reads.
  • ClockScope: Which charge is being clocked.
  • ClockStartEvent: Where an import demurrage, storage or combined clock starts, when the tariff says so.
  • Crossing: What crossingTime returns: exact elapsed time plus the local view at either end.
  • Cutoff: One named deadline in a cut-off stack: how long before the anchor, and at what local time.
  • CutoffScheduleOptions: Options for cutoffSchedule: cutoffAt’s, with atLocalTime read from each entry instead.
  • CutoffTime: One computed deadline in a cut-off schedule.
  • DeliverySchedule: What scheduleDelivery returns: the final local ETA and every leg’s times.
  • DriftReport: What estimateDrift returns.
  • DstTransition: A single DST transition instant: the UTC instant of an offset change plus the offset in effect immediately before and after it.
  • Dwell: What dwellTime returns: exact elapsed time plus the local view every charging regime counts in.
  • EdifactDtmFormat: The UN/EDIFACT data element 2379 (Date or time or period format code) values GMT reads and writes: 11 codes, each in the union of the one kind of value it states.
  • EdifactDtmFormatClass: A UN/EDIFACT data element 2379 format code with the kind of value it states: the result of classifyEdifactDtmFormat.
  • EndOfTimeUnit: Units endOfTime accepts: a Temporal time unit, or "day" for the last moment of the day, each singular or plural.
  • EpcisInstant: When a GS1 EPCIS 2.0 event happened, read three ways: the instant, the UTC offset in force where it happened, and the local wall clock there.
  • EstimateDriftOptions: Options for estimateDrift.
  • FiscalCalendar: Caller-supplied 52/53-week fiscal calendar.
  • FormatCalendarOptions: Options for formatCalendar: the date-time the value is compared with, and the style of the time-of-day half.
  • FormatCalendarUnixOptions: Options for formatCalendarUnix.
  • FormatCalendarUtcOptions: Options for formatCalendarUtc: the instant the day label is measured from, the time zone the days and the clock time are read in, and the width of the time-of-day half.
  • FormatCalendarZonedOptions: Options for formatCalendarZoned: the moment the day label is measured from and the length of the time-of-day half.
  • FormatDurationOptions: How formatDuration writes unit names, and whether it writes zero components.
  • FormatRelativeDateOptions: Options for formatRelativeDate: the reference date, the display unit, the rounding and the wording.
  • FormatRelativeDateTimeOptions: Options for formatRelativeDateTime: the reference date-time, the display unit, the rounding and the wording.
  • FormatRelativeTimeOptions: Options for formatRelativeTime: the reference time, the display unit, the rounding and the wording.
  • FormatRelativeUnixOptions: Options for formatRelativeUnix: the wording of the phrase, the unit and rounding of the distance, and the reference instant, epoch unit and time zone the distance is measured with.
  • FormatRelativeUtcOptions: Options for formatRelativeUtc: the instant the distance is measured from, the unit it is shown in, how it rounds, and the wording Intl.RelativeTimeFormat uses.
  • FormatRelativeZonedOptions: Options for formatRelativeZoned: how the phrase is worded, the unit it counts in, how the count rounds and the moment the distance is measured from.
  • FormatTimeZoneNameOptions: Options for formatTimeZoneName: the form the zone name is written in.
  • FormatUnixOptions: Options for formatUnix: every Intl.DateTimeFormatOptions field, plus the epoch unit, the time zone the value is rendered in and whether the zone name is shown.
  • FormatUtcOptions: Options for formatUtc.
  • FreeTime: What freeTimeExpiry returns: the free-time window as local dates, and the instant it ends.
  • FreeTimeChargeOptions: FreeTimeOptions plus how charged days are counted, and the optional tier boundaries.
  • FreeTimeCharges: What chargeableDays returns: the day count an invoice bills, and the dates that back it.
  • Headway: A headway service: a departure every headway from from, up to (not including) to — the shape of a GTFS frequencies.txt row (headway_secs, start_time, end_time; GTFS Schedule Reference, https://github.com/google/transit/blob/master/gtfs/spec/en/reference.md#frequenciestxt).
  • IsValidDateRangeProps: The argument object of isValidDateRange.
  • LegTime: One leg’s computed times, with the leg’s own tags echoed back.
  • LocalTimeClassification: What a zoneless wall time turns out to be once a zone is attached to it.
  • MultimodalJourney: What multimodalETA returns: the end-to-end ETA, with the time moving and the time waiting kept apart.
  • NanosecondTruncationUnit: Storage precision a nanosecond value can be truncated to.
  • NextDepartureOptions: Options for nextDeparture.
  • NowUnit: Units extractable from the current system local time via getNowUnit.
  • OnTimeRate: What punctualityRate returns: the on-time count, the total, and their ratio.
  • PlainNowUnit: Units extractable from a unix epoch value via parseUnitFromUnix.
  • PlannedActual: One planned/actual pair for punctualityRate.
  • Punctuality: An arrival’s punctuality against a PunctualityTolerance.
  • RelativeDateTimeUnit: Full 7-member RelativeUnit for PlainDateTime-based formatting.
  • RelativeDateUnit: Narrow RelativeUnit for PlainDate-based formatting.
  • RelativeTimeUnit: Narrow RelativeUnit for PlainTime-based formatting.
  • StartOfTimeUnit: Units startOfTime accepts: a Temporal time unit, or "day" for midnight, each singular or plural.
  • TierBand: A band of chargeable-day ordinals and how many of the charged days fell in it.
  • TimeUnit: A time unit in the singular, from "hour" down to "nanosecond", as Temporal’s rounding and difference options name units.
  • TimeZoneNameStyle: Name style for formatTimeZoneName, mirroring Intl.DateTimeFormatOptions’s timeZoneName values.
  • UnixNowUnit: Units extractable from the current Unix timestamp in UTC via getUnixNowUnit.
  • UtcNowUnit: Units extractable from the current UTC instant via getUtcNowUnit.
  • UtcUnit: Units supported by parseUnitFromUtc when extracting a value from a UTC ISO string.
  • WallClockSpanUnit: Units spanWallClock measures a calendar distance in.
  • X12DateTimePeriodFormat: The X12 data element 1250 (Date Time Period Format Qualifier) values GMT reads and writes: 10 codes, each in the union of the one kind of value it states.
  • X12DateTimePeriodFormatClass: An X12 data element 1250 format qualifier with the kind of value it states: the result of classifyX12DateTimePeriodFormat.
  • X12NamedZone: The zone an X12 data element 623 time code names: the result of x12TimeCodeZone.
  • X12TimeCode: The 56 X12 data element 623 (Time Code) values, release 008010, read from Stedi’s X12-licensed dictionary; the X12 text itself was not reached.
  • X12TimeCodeClass: An X12 data element 623 time code with what it states: the result of classifyX12TimeCode.
  • X12TimeElementForm: The four forms of X12 data element 337 (Time), each named by the element’s own mask.
  • ZonedNowUnit: Units extractable from the current time in a specific IANA timeZone, as consumed by getZonedNowUnit.
  • ZonedOffsetUnit: Unit a zoned value’s UTC offset can be read as via getZonedOffsetAs.
  • ZonedParseUnit: Units supported by parseUnitFromZoned when extracting a value from a zoned ISO string.