Unions discriminées

Des unions d’objets avec un champ d’étiquette commun qui permet de distinguer facilement les variantes.

Sur cette page

Exemple

#
TypeScript
type RequestState =
  | { status: 'loading' }
  | { status: 'success'; data: string[] }
  | { status: 'error'; message: string }

function render(state: RequestState): string {
  switch (state.status) {
    case 'loading':
      return 'Chargement…'
    case 'success':
      return `Cours : ${state.data.join(', ')}`
    case 'error':
      return `Erreur : ${state.message}`
  }
}

console.log(render({ status: 'loading' }))
console.log(render({ status: 'success', data: ['HTML', 'CSS'] }))
console.log(render({ status: 'error', message: 'Pas de connexion' }))
Résultat
Chargement…
Cours : HTML, CSS
Erreur : Pas de connexion

Définition et utilisation

#

Une union discriminée est une union de types d’objets où chaque variante possède un champ commun avec une valeur littérale différente, par exemple type: "text" | "image". Ce champ joue le rôle d’étiquette.

Après avoir vérifié l’étiquette (if (block.type === "image"), ou un switch), le compilateur sait exactement à quelle variante il a affaire et vous donne accès à ses champs.

C’est le motif de base pour modéliser des états (chargement, succès, erreur), des événements, des messages ou des types de tâches. Associé à never dans la branche default, il permet de vérifier l’exhaustivité.

Syntaxe

#
Syntaxe
type A = { kind: "a"; … }
type B = { kind: "b"; … }
type Union = A | B

Bonnes pratiques

#
  • Modélisez l’état comme une union discriminée plutôt que comme plusieurs drapeaux séparés (isLoading, error, data). Les combinaisons impossibles cessent d’être possibles.
  • Ajoutez une branche default avec assertNever, afin que le compilateur vous avertisse des variantes non gérées.

Entrées associées

#

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.