Type Alias DateRange

DateRange: AtLeastOne<{
    from?: string;
    to?: string;
}>

A filter for ISO 8601 date-time ranges that include timezone information.

Supports partially or fully bounded intervals. At least one of from or to must be defined.

  • from is inclusive (>=)
  • to is exclusive (<)

Type declaration

  • Optionalfrom?: string

    The inclusive lower bound of the range. Must be an ISO 8601 date-time string with timezone offset.

    Examples:

    • '2024-01-01T00:00:00+10:00'
    • '2024-01-01T00:00:00Z'
  • Optionalto?: string

    The exclusive upper bound of the range. Must be an ISO 8601 date-time string with timezone offset.

    Examples:

    • '2024-12-31T00:00:00+10:00'
    • '2024-12-31T00:00:00Z'
""