Union (A | B)

Un type qui peut être l’un de plusieurs types.

Sur cette page

Exemple

#
TypeScript
function formatId(id: string | number): string {
  if (typeof id === 'number') {
    return `#${id.toString().padStart(4, '0')}`
  }
  return id.toUpperCase()
}

console.log(formatId(42))
console.log(formatId('cw-html'))
Résultat
#0042
CW-HTML

Définition et utilisation

#

Une union relie des types avec une barre verticale : string | number désigne une valeur qui est soit une chaîne, soit un nombre. C’est l’un des mécanismes les plus utilisés de TypeScript, car les données des vrais programmes se présentent souvent sous plusieurs formes.

Sur une valeur de type union, vous ne pouvez utiliser immédiatement que ce qui est commun à tous ses membres. Pour utiliser les méthodes d’un type précis, il faut d’abord le restreindre, par exemple avec une vérification typeof.

Les unions de littéraux ("easy" | "medium" | "hard") sont un moyen simple et léger de lister les valeurs autorisées, souvent plus pratique qu’un enum.

Syntaxe

#
Syntaxe
type Name = TypeA | TypeB | TypeC

Plus d’exemples

#
Seules les méthodes communes sans restriction de type
TypeScript
function length(value: string | number) {
  return value.length
}
// Erreur : Property 'length' does not exist on type 'string | number'.

Bonnes pratiques

#
  • Lorsque les membres d’une union sont des objets, donnez-leur un champ commun avec une valeur littérale (par exemple kind). Vous obtenez ainsi une union discriminée, facile à restreindre.
  • Un tableau d’éléments de types différents s’écrit (string | number)[], et non string | number[].

Entrées associées

#

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