L’opérateur in

Restreint une union d’objets en vérifiant si un objet possède une propriété donnée.

Sur cette page

Exemple

#
TypeScript
type EmailContact = { name: string; email: string }
type PhoneContact = { name: string; phone: string }

function contactLine(contact: EmailContact | PhoneContact): string {
  if ('email' in contact) return `${contact.name} : ${contact.email}`
  return `${contact.name} : tél. ${contact.phone}`
}

console.log(contactLine({ name: 'Léa', email: 'lea@codeworlds.pl' }))
console.log(contactLine({ name: 'Jacques', phone: '+33 6 12 34 56 78' }))
Résultat
Léa : lea@codeworlds.pl
Jacques : tél. +33 6 12 34 56 78

Définition et utilisation

#

L’opérateur in vérifie si un objet possède une propriété portant le nom indiqué. En TypeScript, il restreint les unions d’objets sans étiquette commune : après if ("email" in contact), le compilateur sait qu’il s’agit de la variante avec le champ email.

Il est pratique lorsque les variantes diffèrent par leur ensemble de champs et n’ont pas de champ kind. Si vous pouvez modifier la structure des données, une union discriminée est généralement plus lisible.

Depuis TypeScript 4.9, l’opérateur in restreint aussi les valeurs de type object et unknown : après la vérification, le compilateur sait que la propriété existe, même si son type est unknown.

Syntaxe

#
Syntaxe
if ("field" in object) {
  // object has the field
}

Bonnes pratiques

#
  • L’opérateur in vérifie aussi les propriétés héritées. Pour ne vérifier que les champs propres d’un objet, utilisez Object.hasOwn().
  • Lorsque le nombre de variantes augmente, transformez-les en union discriminée avec un champ kind.

Entrées associées

#

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