Soporte de Intellisense de TypeScript para el Nodo de Código usando JSDoc - Flujo de trabajo de n8n

Usuarios avanzados de n8n: Desarrolladores que usan frecuentemente el nodo Code de n8n para lógica personalizada.
Especialistas en automatización: Aquellos que crean sistemas de flujos de trabajo complejos en n8n y requieren herramientas de depuración robustas.
Creadores de contenido técnico: Personas que documentan o comparten las mejores prácticas para un desarrollo eficiente en n8n.
Cualquiera: Que busque mejorar la calidad del código y reducir errores en sus plantillas de n8n.

Al trabajar con el nodo Code de JavaScript en n8n, depurar y acceder a objetos de entrada complejos (como los devueltos por el nodo de n8n o las operaciones de la API) puede ser complicado sin una autocompletación adecuada. Este flujo de trabajo específico de n8n soluciona esto aprovechando las anotaciones JSDoc, un método muy utilizado en el ecosistema JavaScript.

Al definir la estructura esperada de los objetos —como el objeto Workflow obtenido a través del nodo de la API de n8n— puedes proporcionar a la funcionalidad de código integrada del editor de n8n sugerencias de tipos potentes. Esto da como resultado un Intellisense a nivel de TypeScript, haciendo que escribir, mantener y depurar scripts personalizados complejos dentro de tu flujo de trabajo de n8n sea mucho más eficiente y fiable. Esta técnica es muy valiosa para mejorar la velocidad de desarrollo de cualquier plantilla robusta de n8n.

Este flujo de trabajo demostrativo de n8n utiliza cuatro pasos clave para ilustrar la técnica de Intellisense:

1. Desencadenador (On form submission): El proceso comienza usando un desencadenador básico de Formulario de n8n, que permite iniciar manualmente el flujo de trabajo de n8n para realizar pruebas.


2. Obtener datos del flujo (Get This Workflow): El nodo de n8n se configura para usar la operación get para recuperar toda la estructura de metadatos del flujo de trabajo de n8n en ejecución. Este objeto JSON complejo se pasa al siguiente nodo de n8n.


3. Aplicar Intellisense (Code With Intellisense): Este nodo Code de n8n es la demostración principal. Define dos definiciones de tipo JSDoc (@typedef {Object} Node y / @typedef {Object} Workflow /). Luego, el JSON entrante se convierte usando un comentario JSDoc en línea (/ @type {Workflow} /) sobre la variable wf. Esta acción proporciona un Intellisense perfecto para acceder a propiedades como wf.id, wf.name e iterar a través de wf.nodes dentro del nodo Code de n8n.


4. Mostrar resultados (Display Results): Un nodo final de Formulario de n8n muestra la salida procesada (extraída usando el Intellisense recién activado) en un formato HTML organizado, demostrando la funcionalidad del nodo de n8n anterior.

Para instalar y usar esta potente técnica de desarrollo en tus propias plantillas de n8n:

1. Importar: Copia el JSON del flujo de trabajo de n8n proporcionado y pégalo en tu instancia de n8n a través de la opción 'Importar desde JSON'.


2. Credenciales de la API de n8n: El nodo 'Get This Workflow' de n8n requiere credenciales de API de n8n válidas configuradas bajo el nombre n8n unio API v1. Asegúrate de tener una clave de API activa configurada en n8n.


3. Ejecutar: Ejecuta el desencadenador de n8n 'On form submission' o prueba manualmente el flujo de trabajo de n8n. Observa el nodo de n8n 'Code With Intellisense' mientras editas: al pasar el ratón o escribir propiedades del objeto (como wf.), ahora se mostrarán sugerencias de código útiles.

On form submission (desencadenador de n8n): Actúa como punto de partida para probar este flujo de trabajo de n8n. Es un mecanismo de desencadenador HTTP estándar de n8n.
Get This Workflow (nodo de n8n): Utiliza la API interna de n8n para recuperar la representación JSON completa del flujo de trabajo de n8n que se está ejecutando actualmente. Esto proporciona la estructura de objeto compleja necesaria para el ejemplo de JSDoc.
Code With Intellisense (nodo Code de n8n): El componente central. Define tipos complejos usando JSDoc, específicamente los tipos Workflow y Node. La configuración clave implica la conversión en línea: const wf = / @type {Workflow} / ($input.first().json);, lo cual es esencial para activar la potente función de Intellisense al programar dentro de las plantillas de n8n.

• Display Results (nodo Form de n8n): Muestra el resultado de la ejecución del nodo Code de n8n en una página HTML bien formateada, proporcionando retroalimentación visual inmediata sobre el éxito de la lógica del flujo de trabajo de n8n.