YAML vers TypeScript
Générer des interfaces TypeScript à partir de données YAML
Entrée YAML
Sortie TypeScript
Qu'est-ce que YAML vers TypeScript ?
TypeScript utilise des interfaces et types pour la structure. Cet outil génère des interfaces TypeScript à partir de votre YAML pour typer la config ou les données parsées. La spécification YAML 1.2 définit le format d'entrée.
La conversion s'exécute dans votre navigateur. Rien n'est envoyé à un serveur. Les types générés fonctionnent avec des parseurs comme js-yaml ou le package yaml. Pour JSON vers TypeScript, utilisez JSON vers TypeScript.
Exemples YAML vers TypeScript
Générer des interfaces TypeScript à partir de YAML. Exemple télécom :
Exemple : Enregistrement abonné
Sortie TypeScript:
Cliquez sur le bouton Exemple ci-dessus pour charger d'autres exemples dans l'éditeur.
Comment utiliser cet outil
Coller ou télécharger YAML
Copiez votre YAML et collez-le dans l'éditeur de gauche. Vous pouvez aussi cliquer sur <strong>Télécharger</strong> pour charger un fichier <code>.yaml</code> ou <code>.yml</code>. Le bouton <strong>Exemple</strong> charge des données d'exemple. Un YAML invalide affichera une erreur.
Copier ou télécharger
Utilisez <strong>Copier</strong> ou <strong>Télécharger</strong>. Pour JSON vers TypeScript, utilisez JSON vers TypeScript. Pour formater le YAML, utilisez le Formateur YAML.
Quand YAML vers TypeScript aide
Lors de la création d'apps Node.js ou frontend qui chargent de la config YAML (ex. <code>config.yml</code>, manifests Kubernetes ou workflows CI), vous avez besoin de structures typées pour les données parsées. Coller un échantillon ici vous donne des interfaces TypeScript utilisables avec js-yaml ou le package yaml. Écrire manuellement les types pour du YAML imbriqué complexe est fastidieux ; cet outil infère la structure de votre échantillon.
Les fichiers de config comme application.yml ou les workflows GitHub Actions ont souvent une imbrication profonde. Les types générés aident à détecter les fautes de frappe et fournissent l'autocomplétion dans votre IDE. Pour extraire des valeurs spécifiques d'un grand YAML, convertissez d'abord en JSON et utilisez jq.
Questions fréquentes
Comment parser YAML en TypeScript ?
Utilisez <code>js-yaml</code> ou le package <code>yaml</code>. Parsez la chaîne YAML et assignez au type généré : <code>const config = yaml.parse(str) as MyConfig</code>. Pour validation à l'exécution, envisagez Zod ou io-ts.
js-yaml vs package yaml ?
js-yaml est largement utilisé. Le package yaml a une API différente et une meilleure préservation des commentaires. Les deux fonctionnent avec les types générés.
Mes données sont-elles privées ?
Oui. La génération s'exécute entièrement dans votre navigateur. Aucun YAML ni code n'est envoyé à un serveur.
Champs optionnels vs requis ?
Le générateur infère à partir de l'échantillon. Ajoutez <code>?</code> aux propriétés d'interface pour les champs optionnels. Pour une validation stricte à l'exécution, utilisez Zod ou similaire avec les types générés comme référence.
Puis-je l'utiliser avec Angular ou React ?
Oui. Les types générés fonctionnent dans tout projet TypeScript. Chargez le YAML au build ou à l'exécution et castez vers l'interface générée. Pour la config d'environnement, envisagez de charger le YAML dans un service de config.
Outils connexes
Documentation TypeScript. Spécification YAML. js-yaml. Spécification JSON. MDN.