"esModuleInterop"

Facilite l’import de paquets CommonJS avec la syntaxe des modules ES.

Sur cette page

Exemple

#
JSON
{
  "compilerOptions": {
    "esModuleInterop": true,
    "module": "CommonJS"
  }
}

Définition et utilisation

#

De nombreux paquets npm anciens sont écrits en CommonJS (module.exports = …). L’option esModuleInterop permet de les importer avec la syntaxe ordinaire import express from "express", au lieu de import * as express from "express".

Le compilateur ajoute alors au code généré de petites fonctions auxiliaires qui se comportent comme les bundlers et Node.js lorsqu’ils font cohabiter les deux systèmes de modules.

Activer esModuleInterop active aussi automatiquement allowSyntheticDefaultImports, qui autorise, au stade de la vérification des types, l’import par défaut depuis un module sans export par défaut.

Syntaxe

#
Syntaxe
"esModuleInterop": true

Plus d’exemples

#
Import d’un paquet CommonJS
TypeScript
// avec esModuleInterop
import express from 'express'

// sans esModuleInterop, il fallait écrire :
// import * as express from 'express'

Bonnes pratiques

#
  • Dans les nouveaux projets, laissez esModuleInterop activée. C’est le réglage par défaut des modèles tsc --init.
  • Si un import par défaut renvoie undefined à l’exécution, vérifiez cette option et le format de modules du paquet.

Entrées associées

#

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