Support de l'Intellisense TypeScript pour le nœud Code via JSDoc - Workflow n8n

Utilisateurs avancés de n8n : Développeurs utilisant fréquemment le nœud Code de n8n pour la logique personnalisée.
Spécialistes de l'automatisation : Ceux qui construisent des systèmes de workflow n8n complexes nécessitant des outils de débogage robustes.
Créateurs de contenu technique : Personnes documentant ou partageant les meilleures pratiques pour un développement n8n efficace.
Toute personne : Cherchant à améliorer la qualité du code et à réduire les erreurs dans ses modèles n8n.

Lors du travail avec le nœud Code JavaScript de n8n, le débogage et l'accès aux objets d'entrée complexes (comme ceux renvoyés par le nœud n8n ou les opérations API) peuvent être difficiles sans autocomplétion adéquate. Ce workflow n8n spécifique résout ce problème en exploitant les annotations JSDoc, une méthode largement utilisée dans l'écosystème JavaScript.

En définissant la structure attendue des objets — comme l'objet Workflow récupéré via le nœud API n8n de n8n — vous pouvez fournir des indications de type fortes à la fonctionnalité de code intégrée de l'éditeur n8n. Il en résulte un Intellisense de niveau TypeScript, rendant l'écriture, la maintenance et le débogage de scripts personnalisés complexes dans votre workflow n8n beaucoup plus efficaces et fiables. Cette technique est inestimable pour améliorer la vitesse de développement de tout modèle n8n robuste.

Ce workflow n8n démonstratif utilise quatre étapes clés pour illustrer la technique d'Intellisense :

1. Déclencheur (Soumission de formulaire) : Le processus démarre en utilisant un déclencheur de formulaire n8n de base, qui permet une initialisation manuelle du workflow n8n pour les tests.


2. Récupération des données du Workflow (Obtenir ce Workflow) : Le nœud n8n est configuré pour utiliser l'opération get afin de récupérer la structure de métadonnées complète du workflow n8n en cours d'exécution. Cet objet JSON complexe est transmis au nœud n8n suivant.


3. Application de l'Intellisense (Code avec Intellisense) : Ce nœud Code n8n est la démonstration principale. Il définit deux définitions de type JSDoc (@typedef {Object} Node et / @typedef {Object} Workflow /). Le JSON entrant est ensuite typé à l'aide d'un commentaire JSDoc en ligne (/ @type {Workflow} /) sur la variable wf. Cette action fournit un Intellisense parfait pour accéder aux propriétés comme wf.id, wf.name, et pour itérer sur wf.nodes dans le nœud Code n8n.


4. Affichage des résultats (Afficher les résultats) : Un nœud de formulaire n8n final affiche la sortie analysée (extraite grâce à l'Intellisense nouvellement activé) dans un format HTML organisé, prouvant ainsi la fonctionnalité du nœud n8n précédent.

Pour installer et utiliser cette puissante technique de développement dans vos propres modèles n8n :

1. Importer : Copiez le JSON du workflow n8n fourni et collez-le dans votre instance n8n via l'option 'Importer depuis JSON'.


2. Identifiants API n8n : Le nœud n8n 'Obtenir ce Workflow' nécessite des identifiants API n8n valides configurés sous le nom n8n unio API v1. Assurez-vous d'avoir une clé API active configurée dans n8n.


3. Exécuter : Exécutez le déclencheur n8n 'Soumission de formulaire' ou testez manuellement le workflow n8n. Observez le nœud n8n 'Code avec Intellisense' pendant l'édition : le survol ou la saisie de propriétés d'objet (comme wf.) affichera désormais des suggestions de code utiles.

Soumission de formulaire (déclencheur n8n) : Sert de point de départ pour tester ce workflow n8n. C'est un mécanisme de déclenchement HTTP standard pour n8n.
Obtenir ce Workflow (nœud n8n) : Utilise l'API interne de n8n pour récupérer la représentation JSON complète du workflow n8n actuellement en cours d'exécution. Cela fournit la structure d'objet complexe nécessaire pour l'exemple JSDoc.
Code avec Intellisense (nœud Code n8n) : Le composant central. Il définit des types complexes en utilisant JSDoc, spécifiquement les types Workflow et Node. La configuration clé implique le typage en ligne : const wf = / @type {Workflow} / ($input.first().json);, ce qui est essentiel pour activer la puissante fonctionnalité d'Intellisense lors du codage dans les modèles n8n.

• Afficher les résultats (nœud Formulaire n8n) : Affiche le résultat de l'exécution du nœud Code n8n dans une page HTML joliment formatée, fournissant un retour visuel immédiat sur le succès de la logique du workflow n8n.