instanceof

Restreint le type à une classe en vérifiant si l’objet a été créé par celle-ci.

Sur cette page

Exemple

#
TypeScript
class ValidationError extends Error {
  constructor(public field: string, message: string) {
    super(message)
    this.name = 'ValidationError'
  }
}

function describeError(error: unknown): string {
  if (error instanceof ValidationError) return `Champ ${error.field} : ${error.message}`
  if (error instanceof Error) return `Erreur : ${error.message}`
  return 'Erreur inconnue'
}

console.log(describeError(new ValidationError('email', 'adresse invalide')))
console.log(describeError(new Error('pas de connexion')))
console.log(describeError('oups'))
Résultat
Champ email : adresse invalide
Erreur : pas de connexion
Erreur inconnue

Définition et utilisation

#

L’opérateur instanceof vérifie à l’exécution si un objet provient d’une classe donnée (l’a dans sa chaîne de prototypes). TypeScript s’appuie sur cette vérification pour restreindre le type à l’intérieur du bloc if.

Il est surtout utile avec les erreurs (error instanceof Error), les dates (value instanceof Date) et vos propres classes, par exemple différents types d’exceptions.

Il ne fonctionne qu’avec les classes et constructeurs qui existent après la compilation. Vous ne pouvez pas utiliser instanceof avec une interface, car les interfaces disparaissent en JavaScript.

Syntaxe

#
Syntaxe
if (value instanceof Class) {
  // value: Class
}

Bonnes pratiques

#
  • Dans un bloc catch, l’erreur a le type unknown. Vérifiez error instanceof Error avant de lire message.
  • Pour vérifier la forme d’objets simples (par exemple issus de JSON), instanceof ne fonctionnera pas. Utilisez l’opérateur in ou un type guard.

Entrées associées

#

Pratiquer dans les leçons

#

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