Function iri

iri<const C extends StringValueConstraints & { variant?: Variant } = {}>(
constraints?: C,
): StringShape<{ inferred from <C> }>
Creates a shape for Internationalized Resource Identifier values.

Fixes the datatype to xsd:string. IRIs generalise URIs (RFC 3986) and URLs by admitting the full Unicode character set beyond ASCII; the variant states which subset of the IRI hierarchy is accepted: hierarchical (URLs/IRLs with authority), absolute (scheme-based URIs/IRIs), internal (absolute or root-relative), or relative (any valid reference, the default).

As a limitation, variants are told apart by their scheme and leading slashes rather than parsed against the full RFC 3987 grammar: relative admits any whitespace-free sequence, and the stricter variants check the prefix alone, leaving the rest of the reference unvalidated.
Type Parameters
- const C extends StringValueConstraints & { variant?: Variant } = {}
  The stated constraints
Parameters
- Optionalconstraints: C
  Optional value constraints and IRI variant
Returns StringShape<{ inferred from <C> }>
An immutable shape admitting IRIs of the stated variant, narrowed to the values the constraints enumerate
Throws
TraceError Where the stated constraints contradict one another
See
- RFC 3987 - Internationalized Resource Identifiers
- RFC 3986 - URI Generic Syntax
- Defined in src/string/index.ts:573