Function instant

instant<const C extends StringValueConstraints = {}>(
constraints?: C,
): StringShape<{ inferred from <C> }>
Creates a shape for ISO 8601 date and time values (YYYY-MM-DDThh:mm:ss).

Fixes the datatype to xsd:dateTime and bounds each field and the optional timezone offset to its legal range, under the same end-of-day rule as time and the same day limitation as date.
Type Parameters
- const C extends StringValueConstraints = {}
  The stated constraints
Parameters
- Optionalconstraints: C
  Optional value constraints
Returns StringShape<{ inferred from <C> }>
An immutable shape admitting ISO 8601 date and time values, narrowed to the values the constraints enumerate

Throws
TraceError Where the stated constraints contradict one another

See
XSD 1.0 Part 2: Datatypes § 3.2.7 dateTime
- Defined in src/string/index.ts:769