requireValidLocale

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

Exactement deux lettres ASCII, dans n'importe quelle casse — "en", "UK". Un sous-tag de région ou d'écriture, comme dans "en-US", est refusé : il s'agit du code de langue court, pas d'une étiquette BCP 47 complète.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`value`	`string \\| null \\| undefined`	La valeur à valider.
`message` (facultatif) `= "Expected a valid locale."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

string — la même valeur, typée comme un code de locale.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un code de locale.

Exemples

Ce qui passe et ce qui ne passe pas

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

Voir aussi

Code source

src/lang/string/requireValidLocale.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.