"noUncheckedIndexedAccess"

Ajoute undefined au type d’une lecture par indice, car l’élément à cet indice peut ne pas exister.

Sur cette page

Exemple

#
JSON
{
  "compilerOptions": {
    "strict": true,
    "noUncheckedIndexedAccess": true
  }
}

Définition et utilisation

#

Par défaut, la lecture d’un tableau par indice (scores[3]) ou d’un objet via une signature d’index (prices[course]) a le type de l’élément, par exemple number. Dans un programme en cours d’exécution, une telle lecture peut pourtant renvoyer undefined. L’option noUncheckedIndexedAccess ajoute | undefined au type, et le compilateur force donc à gérer l’élément manquant.

L’option ne fait pas partie du groupe strict et doit être activée séparément. Elle ne concerne pas les champs déclarés par leur nom dans un type, ni les tuples lus avec un indice constant (pair[0] pour le type [string, number]). La boucle for...of et les méthodes comme map() continuent de fournir des éléments du type ordinaire.

Après l’avoir activée dans un projet existant, vous trouverez pas mal d’endroits à corriger, généralement gérés avec ??, ?. ou une condition. En contrepartie, toute une classe d’erreurs « Cannot read properties of undefined » disparaît. Depuis TypeScript 5.9, l’option est activée dans le fichier créé par tsc --init.

Syntaxe

#
Syntaxe
"noUncheckedIndexedAccess": true

Plus d’exemples

#
Lecture d’un tableau
TypeScript
const scores = [72, 95, 88]
const fourth = scores[3]
// const fourth: number | undefined

// fourth.toFixed(1)
// Erreur : 'fourth' is possibly 'undefined'.

console.log((fourth ?? 0).toFixed(1))
console.log(scores[0]?.toFixed(1))
Résultat
0.0
72.0
Un dictionnaire à clés arbitraires
TypeScript
const prices: Record<string, number> = { html: 49, python: 79 }

function priceLabel(course: string): string {
  const price = prices[course]
  // const price: number | undefined
  return price === undefined ? 'indisponible' : `${price} PLN`
}

console.log(priceLabel('python'))
console.log(priceLabel('rust'))
Résultat
79 PLN
indisponible

Bonnes pratiques

#
  • La vérification scores.length > 0 ne restreint pas le type de scores[0]. Stockez l’élément dans une variable et vérifiez celle-ci : const first = scores[0]; if (first !== undefined) ….
  • Au lieu d’une boucle avec indice, utilisez for...of, map() ou forEach(). L’élément a alors le type ordinaire, sans | undefined.
  • Dans un projet existant, activez l’option sur une branche séparée et corrigez les erreurs par lots. La plupart des corrections consistent à ajouter ?? ou une condition.

Entrées associées

#

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