Accueil › TypeScript › Signatures d'index et Record
Signatures d'index et Record
Objets, interfaces et aliasdebutant
Quand les clés ne sont pas connues à l'avance, on déclare leur forme au lieu de les énumérer.
interface Stock {
[produit: string]: number;
}
const s: Stock = { pommes: 3, poires: 12 };
s.bananes = 7; // accepté : toute clé chaîne est permise
Le nom produit n'a aucun effet : il documente. Ce qui compte est le type de
la clé et celui de la valeur.
Record<K, V> dit la même chose, en plus court, et fait beaucoup plus dès que
K n'est pas string :
type Stock2 = Record<string, number>; // dictionnaire ouvert
type Traductions = Record<"fr" | "en", string>; // { fr: string; en: string }
const t: Traductions = { fr: "Bonjour" };
// Erreur TS2741 : Property 'en' is missing in type …
Ce que la signature d'index vous coûte
const s: Stock = { pommes: 3 };
s.pomes; // aucune erreur : « pomes » est une clé valide
s["n'importe"]; // aucune erreur non plus
Sur une interface fermée, s.pomes aurait produit « Property 'pomes' does not
exist on type ». La signature d'index supprime ce filet : toute clé devient
légitime, fautes de frappe comprises.
Pire, le type de ce qu'on lit est faux :
const n: number = s["poires"]; // accepté, et n vaut undefined
console.log(n.toFixed(2)); // TypeError à l'exécution
L'option noUncheckedIndexedAccess corrige ce mensonge en typant tout accès
indexé number | undefined. Elle n'est pas dans strict : il faut l'activer.
Les termes à connaître
- Signature d'index
[cle: string]: Tdéclare que toutes les clés inconnues sont permises et valentT. L'objet devient un dictionnaire ouvert.- Record<K, V>
Le type utilitaire des dictionnaires. Avec
K = stringil équivaut à une signature d'index ; avec une union de clés, il produit des propriétés requises.- Clé fermée
Record<"fr" | "en", string>exige les deux clés et n'en accepte aucune autre. C'est la forme à préférer dès que les clés sont connues.- noUncheckedIndexedAccess
L'option qui ajoute
| undefinedau résultat de tout accès indexé. Sans elle, le compilateur affirme qu'une clé absente contient une valeur.- Mensonge de l'accès indexé
Par défaut,
dico["inexistant"]est typéTalors qu'il vautundefinedà l'exécution. Le type est faux, et le compilateur ne le signale pas.- Clé numérique
[i: number]: Texiste, mais JavaScript convertit toute clé d'objet en chaîne. Une signaturenumberdoit donc être compatible avec la signaturestringdu même type.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.