Enhancement: Add TypeScript definitions (IntelliSense) to Node.js starter

Abierto
  • ¿Algo no está bien?
#344 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@Ram3ez ya está trabajando en esto.

Desde el 15/12/2025.

  • #345 de @Ram3ez — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
55/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
javascript, node.js, typescript
Área
developer-experience

Línea de trabajo

Empieza inspeccionando el index.js del starter de Node.js y la definición propuesta de types.d.ts. Confirma que la referencia de JSDoc y las definiciones cubren req, res, log y error, y luego abre el starter en VS Code para verificar que IntelliSense funciona sin un paso de compilación ni tsconfig.json.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

🔖 Enhancement description

Currently, the Node.js starter function template lacks autocomplete support. I propose adding a types.d.ts file to the starter template and a reference in index.js. This will provide users with immediate IntelliSense for req, res, log, and error out of the box without requiring a build step or a full TypeScript configuration.

🎤 Pitch

The Problem: Developers working with the current Node.js starter often have to switch between their editor and the documentation to recall specific properties of the context object (e.g., distinguishing between req.bodyJson, req.bodyText, or remembering res.json() signatures). This creates friction for new users and increases the chance of minor syntax errors during the "Hello World" phase.

The Solution: By including a lightweight types.d.ts definition file and adding a JSDoc reference (/// ) to the top of index.js, we can leverage VS Code's native ability to provide IntelliSense for JavaScript files.

Key Benefits:

Improved DX: Users get self-documenting code with autocomplete for request headers, response methods, and environment variables.

Zero Config: This works natively in Node.js without needing tsconfig.json, compilation steps, or additional dependencies.

Non-Breaking: This change is purely additive and does not alter the runtime behavior of the function.

I have the types.d.ts definition file ready and tested locally. I would be happy to open a PR for this if assigned.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
Lenguaje dominante
HTML
Estrellas
174
Forks
129
Merge medio
1 d 15 h
PR fusionados (30 d)
11

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de appwrite/templates

Todos los issues de appwrite/templates

Issues similares

Más issues de DevTools

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.