JSON vers TypeScript
Transformez un exemple JSON en interfaces ou alias de type TypeScript. Les objets imbriqués deviennent leurs propres types nommés, les tableaux d’objets sont fusionnés afin que les clés absentes de certains éléments deviennent facultatives, et les valeurs mixtes deviennent des types union. Collez une réponse API, choisissez interface ou type, puis copiez les déclarations que vous pouvez insérer directement dans votre code.
Foire aux questions
Comment les objets imbriqués sont-ils traités ?
Chaque objet imbriqué reçoit sa propre déclaration, nommée d’après la clé qui le contient en PascalCase ; par exemple, address devient Address. Les objets dans les tableaux sont nommés d’après le singulier de la clé du tableau : users devient User et categories devient Category. Les objets qui ont exactement les mêmes champs partagent une déclaration.
Quand une propriété devient-elle facultative ?
Lorsqu’un tableau contient plusieurs objets et qu’une clé est absente de certains d’entre eux, cette clé est marquée comme facultative à l’aide d’un point d’interrogation. Les clés présentes dans chaque élément restent obligatoires. Un objet seul n’a pas d’autres exemples à comparer : toutes ses clés sont donc obligatoires.
Comment les valeurs null sont-elles typées ?
Une clé qui vaut null dans votre exemple est typée null ; si elle vaut null dans certains éléments et contient une chaîne dans d’autres, elle devient string | null. Si un champ peut être null dans les données réelles, mais ne l’est jamais dans votre exemple, ajoutez null manuellement ou collez un exemple qui en contient.
Dois-je choisir interface ou type ?
Les deux décrivent la même structure. Les interfaces peuvent être étendues et fusionnées, ce que de nombreux guides de style recommandent pour les structures d’objets ; les alias de type fonctionnent aussi pour les unions et certaines équipes les utilisent partout. Choisissez ce qu’utilise votre base de code : les champs sont identiques.
Comment les tableaux sont-ils typés ?
Un tableau contenant un seul type de valeur devient ce type suivi de [], par exemple string[] ou User[]. Un tableau contenant plusieurs types devient une union entre parenthèses, par exemple (string | number)[]. Un tableau vide devient unknown[], car l’exemple ne donne aucune information sur ses éléments.
Que deviennent les clés qui ne sont pas des identifiants valides ?
Les clés contenant des espaces, des tirets ou d’autres caractères interdits dans un identifiant TypeScript sont écrites entre guillemets, par exemple "first-name": string, ce qui est valide en TypeScript et correspond exactement à JSON.
Les nombres sont-ils typés comme des entiers ou des nombres à virgule flottante ?
TypeScript ne comporte qu’un seul type numérique : les entiers comme les nombres décimaux deviennent donc number. Si vous devez distinguer les valeurs entières, le générateur de schémas JSON distingue integer de number.
Puis-je renommer le type racine ?
Oui. Saisissez un nom pour le type racine, par exemple ApiResponse. Il est converti en PascalCase, et les types imbriqués conservent les noms dérivés de leurs clés. Lorsque le niveau supérieur de votre JSON est un tableau ou une valeur seule, la racine devient un alias de type pour celui-ci.
Les dates sont-elles détectées ?
Non. JSON ne comporte pas de type date : une date dans votre exemple est donc une chaîne et est typée string. Convertissez-la en Date dans votre code après l’analyse, ou affinez le type manuellement si vous utilisez un type littéral de modèle.
Quelle peut être la taille du JSON ?
Jusqu’à 1,000,000 caractères, avec un imbrication maximale de 64 niveaux. L’exemple est uniquement analysé pour produire les types et n’est pas stocké.