requireValidLocale

function requireValidLocale(
  value: string | null | undefined,
  message: string = "Expected a valid locale."
): string;

Genau zwei ASCII-Buchstaben in beliebiger Schreibweise — "en", "UK". Ein Regions- oder Schrift-Subtag wie in "en-US" wird abgelehnt: gemeint ist der kurze Sprachcode, nicht ein vollständiges BCP-47-Tag.

isX und nonX beantworten eine Frage und unterbrechen den Ablauf nie; requireX und requireNonX geben den Wert zurück oder werfen. Das Schema erklärt Konventionen der Prüfungen.

Parameter

Parameter	Typ	Beschreibung
`value`	`string \\| null \\| undefined`	Der zu validierende Wert.
`message` (optional) `= "Expected a valid locale."`	`string`	Die Meldung der Ausnahme. Ohne Angabe wird eine Standardmeldung verwendet.

Rückgabewert

string — denselben Wert, typisiert als einen Gebietsschema-Code.

Ausnahmen

Ausnahme	Bedingung
`IllegalArgumentException`	der Wert ist nicht ein Gebietsschema-Code.

Beispiele

Was besteht und was nicht

requireValidLocale("en"); // => "en"
requireValidLocale("UK"); // => "UK"
requireValidLocale("en-US"); // throws IllegalArgumentException
requireValidLocale("eng"); // throws IllegalArgumentException

Siehe auch

Quellcode

src/lang/string/requireValidLocale.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.