import type

Un import réservé aux types, qui disparaît complètement du JavaScript généré.

Sur cette page

Exemple

#
TypeScript
// src/lessons.ts
import type { Course } from './types'
import { type Lesson, formatMinutes } from './format'

export function describeLesson(course: Course, lesson: Lesson): string {
  return `${course.title}: ${lesson.title} (${formatMinutes(lesson.minutes)})`
}

// Résultat de la compilation (JavaScript) :
// import { formatMinutes } from './format';
// export function describeLesson(course, lesson) {
//     return `${course.title}: ${lesson.title} (${formatMinutes(lesson.minutes)})`;
// }

Définition et utilisation

#

La syntaxe import type { Course } from "./types" n’importe que des types depuis un module. Après la compilation, un tel import disparaît sans laisser de trace, donc le module n’est pas chargé à l’exécution. Vous n’ajoutez pas de code au bundle par accident, et vous ne créez pas de dépendance circulaire juste parce que vous avez besoin d’un type d’un autre module.

Vous pouvez aussi marquer des noms individuels dans un import ordinaire : import { type Lesson, formatMinutes } from "./format". Lesson disparaît du JavaScript, et formatMinutes reste. export type { … } fonctionne de la même façon pour réexporter des types d’un autre module.

Un nom importé avec import type ne peut être utilisé que comme type. Une classe ou un enum importé ainsi ne peut pas servir avec new, instanceof ou Object.values(). Marquer les imports de types est obligatoire avec l’option verbatimModuleSyntax, et cela aide les outils qui transpilent chaque fichier séparément, comme esbuild, SWC ou Babel.

Syntaxe

#
Syntaxe
import type { Type } from "./module"
import { type Type, value } from "./module"
export type { Type } from "./module"

Plus d’exemples

#
Un nom issu de import type n’est pas une valeur
TypeScript
import type { Level, Certificate } from './types'

let saved: Certificate | null = null // utilisé comme type : correct

const levels = Object.values(Level)
// Erreur : 'Level' cannot be used as a value because it was imported using 'import type'.

const cert = new Certificate('Léa')
// Erreur : 'Certificate' cannot be used as a value because it was imported using 'import type'.
Un point d’entrée unique pour un module
TypeScript
// src/index.ts
export type { Course } from './types'
export { type Lesson, formatMinutes } from './format'

Bonnes pratiques

#
  • La règle de lint @typescript-eslint/consistent-type-imports impose de marquer les imports de types et peut les corriger automatiquement.
  • Si deux modules s’importent mutuellement uniquement pour utiliser les types de l’autre, remplacez ces imports par import type. La dépendance circulaire disparaît du programme en cours d’exécution.
  • Avec l’option verbatimModuleSyntax, import { type A } from "./a" laisse un import vide import {} from "./a" dans le JavaScript, alors que import type { A } disparaît complètement. Lorsque vous ne prenez que des types d’un module, choisissez import type.

Entrées associées

#

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